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

<refnamediv>
<refname>CamelTextIndex</refname>
<refpurpose></refpurpose>
</refnamediv>

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

<synopsis>
<link linkend="void">void</link>                (<link linkend="CamelTextIndexFunc">*CamelTextIndexFunc</link>)               (<link linkend="CamelTextIndex">CamelTextIndex</link> *idx,
                                                         const <link linkend="char">char</link> *word,
                                                         <link linkend="char">char</link> *buffer);
                    <link linkend="CamelTextIndex">CamelTextIndex</link>;
                    <link linkend="CamelTextIndexCursor">CamelTextIndexCursor</link>;
                    <link linkend="CamelTextIndexKeyCursor">CamelTextIndexKeyCursor</link>;
                    <link linkend="CamelTextIndexName">CamelTextIndexName</link>;
<link linkend="CamelTextIndex">CamelTextIndex</link> *    <link linkend="camel-text-index-new">camel_text_index_new</link>                (const <link linkend="char">char</link> *path,
                                                         <link linkend="int">int</link> flags);
<link linkend="int">int</link>                 <link linkend="camel-text-index-check">camel_text_index_check</link>              (const <link linkend="char">char</link> *path);
<link linkend="int">int</link>                 <link linkend="camel-text-index-rename">camel_text_index_rename</link>             (const <link linkend="char">char</link> *old,
                                                         const <link linkend="char">char</link> *new);
<link linkend="int">int</link>                 <link linkend="camel-text-index-remove">camel_text_index_remove</link>             (const <link linkend="char">char</link> *old);
<link linkend="void">void</link>                <link linkend="camel-text-index-dump">camel_text_index_dump</link>               (<link linkend="CamelTextIndex">CamelTextIndex</link> *idx);
<link linkend="void">void</link>                <link linkend="camel-text-index-info">camel_text_index_info</link>               (<link linkend="CamelTextIndex">CamelTextIndex</link> *idx);
<link linkend="void">void</link>                <link linkend="camel-text-index-validate">camel_text_index_validate</link>           (<link linkend="CamelTextIndex">CamelTextIndex</link> *idx);
</synopsis>
</refsynopsisdiv>









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

<refsect1 id="camel-CamelTextIndexName.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="CamelTextIndexFunc" role="function">
<title>CamelTextIndexFunc ()</title>
<indexterm zone="CamelTextIndexFunc"><primary sortas="CamelTextIndexFunc">CamelTextIndexFunc</primary></indexterm><programlisting><link linkend="void">void</link>                (*CamelTextIndexFunc)               (<link linkend="CamelTextIndex">CamelTextIndex</link> *idx,
                                                         const <link linkend="char">char</link> *word,
                                                         <link linkend="char">char</link> *buffer);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>idx</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>word</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>buffer</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="CamelTextIndex" role="struct">
<title>CamelTextIndex</title>
<indexterm zone="CamelTextIndex"><primary sortas="CamelTextIndex">CamelTextIndex</primary></indexterm><programlisting>typedef struct {
	CamelIndex parent;

	struct _CamelTextIndexPrivate *priv;
} CamelTextIndex;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="CamelTextIndexCursor" role="struct">
<title>CamelTextIndexCursor</title>
<indexterm zone="CamelTextIndexCursor"><primary sortas="CamelTextIndexCursor">CamelTextIndexCursor</primary></indexterm><programlisting>typedef struct {
	CamelIndexCursor parent;

	struct _CamelTextIndexCursorPrivate *priv;
} CamelTextIndexCursor;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="CamelTextIndexKeyCursor" role="struct">
<title>CamelTextIndexKeyCursor</title>
<indexterm zone="CamelTextIndexKeyCursor"><primary sortas="CamelTextIndexKeyCursor">CamelTextIndexKeyCursor</primary></indexterm><programlisting>typedef struct {
	CamelIndexCursor parent;

	struct _CamelTextIndexKeyCursorPrivate *priv;
} CamelTextIndexKeyCursor;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="CamelTextIndexName" role="struct">
<title>CamelTextIndexName</title>
<indexterm zone="CamelTextIndexName"><primary sortas="CamelTextIndexName">CamelTextIndexName</primary></indexterm><programlisting>typedef struct {
	CamelIndexName parent;

	struct _CamelTextIndexNamePrivate *priv;
} CamelTextIndexName;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="camel-text-index-new" role="function">
<title>camel_text_index_new ()</title>
<indexterm zone="camel-text-index-new"><primary sortas="camel_text_index_new">camel_text_index_new</primary></indexterm><programlisting><link linkend="CamelTextIndex">CamelTextIndex</link> *    camel_text_index_new                (const <link linkend="char">char</link> *path,
                                                         <link linkend="int">int</link> flags);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>path</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-text-index-check" role="function">
<title>camel_text_index_check ()</title>
<indexterm zone="camel-text-index-check"><primary sortas="camel_text_index_check">camel_text_index_check</primary></indexterm><programlisting><link linkend="int">int</link>                 camel_text_index_check              (const <link linkend="char">char</link> *path);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>path</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-text-index-rename" role="function">
<title>camel_text_index_rename ()</title>
<indexterm zone="camel-text-index-rename"><primary sortas="camel_text_index_rename">camel_text_index_rename</primary></indexterm><programlisting><link linkend="int">int</link>                 camel_text_index_rename             (const <link linkend="char">char</link> *old,
                                                         const <link linkend="char">char</link> *new);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>old</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-text-index-remove" role="function">
<title>camel_text_index_remove ()</title>
<indexterm zone="camel-text-index-remove"><primary sortas="camel_text_index_remove">camel_text_index_remove</primary></indexterm><programlisting><link linkend="int">int</link>                 camel_text_index_remove             (const <link linkend="char">char</link> *old);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>old</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-text-index-dump" role="function">
<title>camel_text_index_dump ()</title>
<indexterm zone="camel-text-index-dump"><primary sortas="camel_text_index_dump">camel_text_index_dump</primary></indexterm><programlisting><link linkend="void">void</link>                camel_text_index_dump               (<link linkend="CamelTextIndex">CamelTextIndex</link> *idx);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>idx</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-text-index-info" role="function">
<title>camel_text_index_info ()</title>
<indexterm zone="camel-text-index-info"><primary sortas="camel_text_index_info">camel_text_index_info</primary></indexterm><programlisting><link linkend="void">void</link>                camel_text_index_info               (<link linkend="CamelTextIndex">CamelTextIndex</link> *idx);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>idx</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-text-index-validate" role="function">
<title>camel_text_index_validate ()</title>
<indexterm zone="camel-text-index-validate"><primary sortas="camel_text_index_validate">camel_text_index_validate</primary></indexterm><programlisting><link linkend="void">void</link>                camel_text_index_validate           (<link linkend="CamelTextIndex">CamelTextIndex</link> *idx);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>idx</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
