<refentry id="camel-CamelLocalFolder">
<refmeta>
<refentrytitle role="top_of_page" id="camel-CamelLocalFolder.top_of_page">CamelLocalFolder</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>CAMEL Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>CamelLocalFolder</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="camel-CamelLocalFolder.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="CamelLocalFolder">CamelLocalFolder</link>;
<link linkend="CamelLocalFolder">CamelLocalFolder</link>*   <link linkend="camel-local-folder-construct">camel_local_folder_construct</link>        (<link linkend="CamelLocalFolder">CamelLocalFolder</link> *lf,
                                                         <link linkend="CamelStore">CamelStore</link> *parent_store,
                                                         const <link linkend="char">char</link> *full_name,
                                                         <link linkend="guint32">guint32</link> flags,
                                                         <link linkend="CamelException">CamelException</link> *ex);
<link linkend="int">int</link>                 <link linkend="camel-local-folder-lock">camel_local_folder_lock</link>             (<link linkend="CamelLocalFolder">CamelLocalFolder</link> *lf,
                                                         <link linkend="CamelLockType">CamelLockType</link> type,
                                                         <link linkend="CamelException">CamelException</link> *ex);
<link linkend="int">int</link>                 <link linkend="camel-local-folder-unlock">camel_local_folder_unlock</link>           (<link linkend="CamelLocalFolder">CamelLocalFolder</link> *lf);
</synopsis>
</refsynopsisdiv>









<refsect1 id="camel-CamelLocalFolder.description" role="desc">
<title role="desc.title">Description</title>
<para>

</para>
</refsect1>

<refsect1 id="camel-CamelLocalFolder.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="CamelLocalFolder" role="struct">
<title>CamelLocalFolder</title>
<indexterm zone="CamelLocalFolder"><primary>CamelLocalFolder</primary></indexterm><programlisting>typedef struct {
	CamelFolder parent_object;
	struct _CamelLocalFolderPrivate *priv;

	guint32 flags;		/* open mode flags */

	int locked;		/* lock counter */
	CamelLockType locktype;	/* what type of lock we have */

	char *base_path;	/* base path of the local folder */
	char *folder_path;	/* the path to the folder itself */
	char *summary_path;	/* where the summary lives */
	char *index_path;	/* where the index file lives */

	CamelIndex *index;	   /* index for this folder */
	CamelFolderSearch *search; /* used to run searches, we just use the real thing (tm) */
	CamelFolderChangeInfo *changes;	/* used to store changes to the folder during processing */
} CamelLocalFolder;
</programlisting>
<para>

</para></refsect2>
<refsect2 id="camel-local-folder-construct" role="function">
<title>camel_local_folder_construct ()</title>
<indexterm zone="camel-local-folder-construct"><primary>camel_local_folder_construct</primary></indexterm><programlisting><link linkend="CamelLocalFolder">CamelLocalFolder</link>*   camel_local_folder_construct        (<link linkend="CamelLocalFolder">CamelLocalFolder</link> *lf,
                                                         <link linkend="CamelStore">CamelStore</link> *parent_store,
                                                         const <link linkend="char">char</link> *full_name,
                                                         <link linkend="guint32">guint32</link> flags,
                                                         <link linkend="CamelException">CamelException</link> *ex);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>lf</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>parent_store</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>full_name</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ex</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-local-folder-lock" role="function">
<title>camel_local_folder_lock ()</title>
<indexterm zone="camel-local-folder-lock"><primary>camel_local_folder_lock</primary></indexterm><programlisting><link linkend="int">int</link>                 camel_local_folder_lock             (<link linkend="CamelLocalFolder">CamelLocalFolder</link> *lf,
                                                         <link linkend="CamelLockType">CamelLockType</link> type,
                                                         <link linkend="CamelException">CamelException</link> *ex);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>lf</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ex</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-local-folder-unlock" role="function">
<title>camel_local_folder_unlock ()</title>
<indexterm zone="camel-local-folder-unlock"><primary>camel_local_folder_unlock</primary></indexterm><programlisting><link linkend="int">int</link>                 camel_local_folder_unlock           (<link linkend="CamelLocalFolder">CamelLocalFolder</link> *lf);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>lf</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
