Added: incubator/lucene4c/trunk/www/apidocs/lcn__directory_8h-source.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__directory_8h-source.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__directory_8h-source.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__directory_8h-source.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,178 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Lucene4c: lcn_directory.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.0 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> +<div class="nav"> +<a class="el" href="dir_000000.html">include</a></div> +<h1>lcn_directory.h</h1><a href="lcn__directory_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/* Copyright 2005 The Apache Software Foundation or its licensors, as</span> +00002 <span class="comment"> * applicable.</span> +00003 <span class="comment"> *</span> +00004 <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span> +00005 <span class="comment"> * you may not use this file except in compliance with the License.</span> +00006 <span class="comment"> * You may obtain a copy of the License at</span> +00007 <span class="comment"> *</span> +00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span> +00009 <span class="comment"> *</span> +00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span> +00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span> +00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> +00013 <span class="comment"> * See the License for the specific language governing permissions and</span> +00014 <span class="comment"> * limitations under the License.</span> +00015 <span class="comment"> */</span> +00016 <span class="comment"></span> +00017 <span class="comment">/**</span> +00018 <span class="comment"> * @file lcn_directory.h</span> +00019 <span class="comment"> * @brief Routines for working with various types of directories</span> +00020 <span class="comment"> */</span> +00021 +00022 <span class="preprocessor">#ifndef _LCN_DIRECTORY_H</span> +00023 <span class="preprocessor"></span><span class="preprocessor">#define _LCN_DIRECTORY_H</span> +00024 <span class="preprocessor"></span> +00025 <span class="preprocessor">#include "<a class="code" href="lcn__types_8h.html">lcn_types.h</a>"</span> +00026 <span class="preprocessor">#include "<a class="code" href="lcn__istream_8h.html">lcn_istream.h</a>"</span> +00027 +00028 <span class="preprocessor">#include <apr_hash.h></span> +00029 <span class="preprocessor">#include <apr_tables.h></span> +00030 <span class="preprocessor">#include <apr_time.h></span> +00031 +00032 <span class="preprocessor">#ifdef __cplusplus</span> +00033 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> { +00034 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00035 <span class="comment"></span> +00036 <span class="comment">/** An opaque directory object. */</span> +<a name="l00037"></a><a class="code" href="lcn__directory_8h.html#a0">00037</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="lcn__directory_8h.html#a0">lcn_directory_t</a> <a class="code" href="lcn__directory_8h.html#a0">lcn_directory_t</a>; +00038 <span class="comment"></span> +00039 <span class="comment">/** An entry in a ram-based directory. */</span> +<a name="l00040"></a><a class="code" href="structlcn__directory__entry__t.html">00040</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{ +<a name="l00041"></a><a class="code" href="structlcn__directory__entry__t.html#o0">00041</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *bytes; <span class="comment">/**< The actual contents of the file */</span> +<a name="l00042"></a><a class="code" href="structlcn__directory__entry__t.html#o1">00042</a> apr_size_t len; <span class="comment">/**< The length of the contents in bytes */</span> +<a name="l00043"></a><a class="code" href="structlcn__directory__entry__t.html#o2">00043</a> apr_time_t mtime; <span class="comment">/**< The time the file was last modified on */</span> +00044 } <a class="code" href="structlcn__directory__entry__t.html">lcn_directory_entry_t</a>; +00045 <span class="comment"></span> +00046 <span class="comment">/** Open a new ram-backed directory @a dir, allocated within @a pool.</span> +00047 <span class="comment"> *</span> +00048 <span class="comment"> * @a contents maps from <tt>const char *</tt> filenames to pointers to</span> +00049 <span class="comment"> * @c lcn_directory_entry_t objects.</span> +00050 <span class="comment"> */</span> +00051 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00052 <a class="code" href="lcn__directory_8h.html#a1">lcn_ram_directory_open</a> (lcn_directory_t **dir, +00053 apr_hash_t *contents, +00054 apr_pool_t *pool); +00055 <span class="comment"></span> +00056 <span class="comment">/** Open a new directory object @a dir which corresponds to the filesystem</span> +00057 <span class="comment"> * directory located at @a path, all allocation is done within @a pool.</span> +00058 <span class="comment"> */</span> +00059 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00060 <a class="code" href="lcn__directory_8h.html#a2">lcn_fs_directory_open</a> (lcn_directory_t **dir, +00061 <span class="keyword">const</span> <span class="keywordtype">char</span> *path, +00062 apr_pool_t *pool); +00063 <span class="comment"></span> +00064 <span class="comment">/** Open an new compound file stream directory @a dir, using the stream</span> +00065 <span class="comment"> * @a cfsfile for the backing store, all allocation is done within @a pool.</span> +00066 <span class="comment"> */</span> +00067 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00068 <a class="code" href="lcn__directory_8h.html#a3">lcn_cfs_directory_open</a> (lcn_directory_t **dir, +00069 lcn_istream_t *cfsfile, +00070 apr_pool_t *pool); +00071 <span class="comment"></span> +00072 <span class="comment">/** Return in @a contents a list of the files within directory @a d, allocated</span> +00073 <span class="comment"> * in @a pool.</span> +00074 <span class="comment"> *</span> +00075 <span class="comment"> * @a contents will contain <tt>const char *</tt> filenames.</span> +00076 <span class="comment"> */</span> +00077 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00078 <a class="code" href="lcn__directory_8h.html#a4">lcn_directory_list</a> (apr_array_header_t **contents, +00079 <span class="keyword">const</span> lcn_directory_t *d, +00080 apr_pool_t *pool); +00081 <span class="comment"></span> +00082 <span class="comment">/** If file @a name exists in directory @a d return @c TRUE in @a result,</span> +00083 <span class="comment"> * otherwise return @c FALSE in @a result.</span> +00084 <span class="comment"> *</span> +00085 <span class="comment"> * @a pool is used for all temporary allocations.</span> +00086 <span class="comment"> */</span> +00087 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00088 <a class="code" href="lcn__directory_8h.html#a5">lcn_directory_file_exists</a> (lcn_boolean_t *result, +00089 <span class="keyword">const</span> lcn_directory_t *d, +00090 <span class="keyword">const</span> <span class="keywordtype">char</span> *name, +00091 apr_pool_t *pool); +00092 <span class="comment"></span> +00093 <span class="comment">/** Return the time file @a name in directory @a d was modified in @a result,</span> +00094 <span class="comment"> * using @a pool for temporary allocations.</span> +00095 <span class="comment"> */</span> +00096 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00097 <a class="code" href="lcn__directory_8h.html#a6">lcn_directory_file_modified</a> (apr_time_t *result, +00098 <span class="keyword">const</span> lcn_directory_t *d, +00099 <span class="keyword">const</span> <span class="keywordtype">char</span> *name, +00100 apr_pool_t *pool); +00101 <span class="comment"></span> +00102 <span class="comment">/** Update the modification time for file @a name in directory @a d, using</span> +00103 <span class="comment"> * @a pool for any temporary allocations.</span> +00104 <span class="comment"> */</span> +00105 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00106 <a class="code" href="lcn__directory_8h.html#a7">lcn_directory_touch_file</a> (lcn_directory_t *d, +00107 <span class="keyword">const</span> <span class="keywordtype">char</span> *name, +00108 apr_pool_t *pool); +00109 <span class="comment"></span> +00110 <span class="comment">/** Delete file @a name in directory @a d, using @a pool for any temporary</span> +00111 <span class="comment"> * allocations.</span> +00112 <span class="comment"> */</span> +00113 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00114 <a class="code" href="lcn__directory_8h.html#a8">lcn_directory_delete_file</a> (lcn_directory_t *d, +00115 <span class="keyword">const</span> <span class="keywordtype">char</span> *name, +00116 apr_pool_t *pool); +00117 <span class="comment"></span> +00118 <span class="comment">/** Rename file @a from to @a to within directory @a d, using @a pool for</span> +00119 <span class="comment"> * temporary allocations.</span> +00120 <span class="comment"> */</span> +00121 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00122 <a class="code" href="lcn__directory_8h.html#a9">lcn_directory_rename_file</a> (lcn_directory_t *d, +00123 <span class="keyword">const</span> <span class="keywordtype">char</span> *from, +00124 <span class="keyword">const</span> <span class="keywordtype">char</span> *to, +00125 apr_pool_t *pool); +00126 +00127 <span class="preprocessor">#ifdef NOTYET</span> +00128 <span class="preprocessor"></span><a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00129 lcn_directory_create_file (lcn_ostream_t **result, +00130 lcn_directory_t *d, +00131 <span class="keyword">const</span> <span class="keywordtype">char</span> *name, +00132 apr_pool_t *pool); +00133 <span class="preprocessor">#endif</span> +00134 <span class="preprocessor"></span><span class="comment"></span> +00135 <span class="comment">/** Open file @a name in directory @a d for reading, returning a corresponding</span> +00136 <span class="comment"> * stream in @a result, using @a pool for all allocation.</span> +00137 <span class="comment"> */</span> +00138 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00139 <a class="code" href="lcn__directory_8h.html#a10">lcn_directory_open_file</a> (lcn_istream_t **result, +00140 <span class="keyword">const</span> lcn_directory_t *d, +00141 <span class="keyword">const</span> <span class="keywordtype">char</span> *name, +00142 apr_pool_t *pool); +00143 +00144 <span class="preprocessor">#ifdef NOTYET</span> +00145 <span class="preprocessor"></span><a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00146 lcn_directory_make_lock (lcn_lock_t **lock, +00147 lcn_directory_t *d, +00148 <span class="keyword">const</span> <span class="keywordtype">char</span> *name, +00149 apr_pool_t *pool); +00150 <span class="preprocessor">#endif</span> +00151 <span class="preprocessor"></span><span class="comment"></span> +00152 <span class="comment">/** Close directory @a d, using @a pool for any temporary allocation.</span> +00153 <span class="comment"> *</span> +00154 <span class="comment"> * @note This isn't strictly necessary, you can just let pool cleanups clean</span> +00155 <span class="comment"> * up the directory for you if you want.</span> +00156 <span class="comment"> */</span> +00157 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00158 <a class="code" href="lcn__directory_8h.html#a11">lcn_directory_close</a> (lcn_directory_t *d, apr_pool_t *pool); +00159 +00160 <span class="preprocessor">#ifdef __cplusplus</span> +00161 <span class="preprocessor"></span>} +00162 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00163 +00164 <span class="preprocessor">#endif</span> +</pre></div><hr size="1"><address style="align: right;"><small>Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by +<a href="http://www.doxygen.org/index.html";> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.0 </small></address> +</body> +</html>
Added: incubator/lucene4c/trunk/www/apidocs/lcn__directory_8h.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__directory_8h.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__directory_8h.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__directory_8h.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,259 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Lucene4c: lcn_directory.h File Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.0 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> +<div class="nav"> +<a class="el" href="dir_000000.html">include</a></div> +<h1>lcn_directory.h File Reference</h1>Routines for working with various types of directories. <a href="#_details">More...</a> +<p> +<code>#include "<a class="el" href="lcn__types_8h-source.html">lcn_types.h</a>"</code><br> +<code>#include "<a class="el" href="lcn__istream_8h-source.html">lcn_istream.h</a>"</code><br> +<code>#include <apr_hash.h></code><br> +<code>#include <apr_tables.h></code><br> +<code>#include <apr_time.h></code><br> + +<p> +<a href="lcn__directory_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0" doxytag="lcn_directory.h::lcn_directory_t"></a> +typedef <a class="el" href="lcn__directory_8h.html#a0">lcn_directory_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__directory_8h.html#a0">lcn_directory_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">An opaque directory object. <br></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__directory_8h.html#a1">lcn_ram_directory_open</a> (<a class="el" href="lcn__directory_8h.html#a0">lcn_directory_t</a> **dir, apr_hash_t *contents, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a new ram-backed directory <em>dir</em>, allocated within <em>pool</em>. <a href="#a1"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2" doxytag="lcn_directory.h::lcn_fs_directory_open"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__directory_8h.html#a2">lcn_fs_directory_open</a> (<a class="el" href="lcn__directory_8h.html#a0">lcn_directory_t</a> **dir, const char *path, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a new directory object <em>dir</em> which corresponds to the filesystem directory located at <em>path</em>, all allocation is done within <em>pool</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3" doxytag="lcn_directory.h::lcn_cfs_directory_open"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__directory_8h.html#a3">lcn_cfs_directory_open</a> (<a class="el" href="lcn__directory_8h.html#a0">lcn_directory_t</a> **dir, <a class="el" href="lcn__istream_8h.html#a0">lcn_istream_t</a> *cfsfile, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Open an new compound file stream directory <em>dir</em>, using the stream <em>cfsfile</em> for the backing store, all allocation is done within <em>pool</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__directory_8h.html#a4">lcn_directory_list</a> (apr_array_header_t **contents, const <a class="el" href="lcn__directory_8h.html#a0">lcn_directory_t</a> *d, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return in <em>contents</em> a list of the files within directory <em>d</em>, allocated in <em>pool</em>. <a href="#a4"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__directory_8h.html#a5">lcn_directory_file_exists</a> (<a class="el" href="lcn__types_8h.html#a8">lcn_boolean_t</a> *result, const <a class="el" href="lcn__directory_8h.html#a0">lcn_directory_t</a> *d, const char *name, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">If file <em>name</em> exists in directory <em>d</em> return <code>TRUE</code> in <em>result</em>, otherwise return <code>FALSE</code> in <em>result</em>. <a href="#a5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6" doxytag="lcn_directory.h::lcn_directory_file_modified"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__directory_8h.html#a6">lcn_directory_file_modified</a> (apr_time_t *result, const <a class="el" href="lcn__directory_8h.html#a0">lcn_directory_t</a> *d, const char *name, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the time file <em>name</em> in directory <em>d</em> was modified in <em>result</em>, using <em>pool</em> for temporary allocations. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7" doxytag="lcn_directory.h::lcn_directory_touch_file"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__directory_8h.html#a7">lcn_directory_touch_file</a> (<a class="el" href="lcn__directory_8h.html#a0">lcn_directory_t</a> *d, const char *name, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Update the modification time for file <em>name</em> in directory <em>d</em>, using <em>pool</em> for any temporary allocations. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8" doxytag="lcn_directory.h::lcn_directory_delete_file"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__directory_8h.html#a8">lcn_directory_delete_file</a> (<a class="el" href="lcn__directory_8h.html#a0">lcn_directory_t</a> *d, const char *name, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete file <em>name</em> in directory <em>d</em>, using <em>pool</em> for any temporary allocations. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9" doxytag="lcn_directory.h::lcn_directory_rename_file"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__directory_8h.html#a9">lcn_directory_rename_file</a> (<a class="el" href="lcn__directory_8h.html#a0">lcn_directory_t</a> *d, const char *from, const char *to, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Rename file <em>from</em> to <em>to</em> within directory <em>d</em>, using <em>pool</em> for temporary allocations. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a10" doxytag="lcn_directory.h::lcn_directory_open_file"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__directory_8h.html#a10">lcn_directory_open_file</a> (<a class="el" href="lcn__istream_8h.html#a0">lcn_istream_t</a> **result, const <a class="el" href="lcn__directory_8h.html#a0">lcn_directory_t</a> *d, const char *name, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Open file <em>name</em> in directory <em>d</em> for reading, returning a corresponding stream in <em>result</em>, using <em>pool</em> for all allocation. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__directory_8h.html#a11">lcn_directory_close</a> (<a class="el" href="lcn__directory_8h.html#a0">lcn_directory_t</a> *d, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Close directory <em>d</em>, using <em>pool</em> for any temporary allocation. <a href="#a11"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Routines for working with various types of directories. +<p> + +<p> +Definition in file <a class="el" href="lcn__directory_8h-source.html">lcn_directory.h</a>.<hr><h2>Function Documentation</h2> +<a class="anchor" name="a11" doxytag="lcn_directory.h::lcn_directory_close"></a><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"><a class="el" href="structlcn__error__t.html">lcn_error_t</a>* lcn_directory_close </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="lcn__directory_8h.html#a0">lcn_directory_t</a> * </td> + <td class="mdname" nowrap> <em>d</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>apr_pool_t * </td> + <td class="mdname" nowrap> <em>pool</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Close directory <em>d</em>, using <em>pool</em> for any temporary allocation. +<p> +<dl compact><dt><b>Note:</b></dt><dd>This isn't strictly necessary, you can just let pool cleanups clean up the directory for you if you want. </dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="a5" doxytag="lcn_directory.h::lcn_directory_file_exists"></a><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"><a class="el" href="structlcn__error__t.html">lcn_error_t</a>* lcn_directory_file_exists </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="lcn__types_8h.html#a8">lcn_boolean_t</a> * </td> + <td class="mdname" nowrap> <em>result</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const <a class="el" href="lcn__directory_8h.html#a0">lcn_directory_t</a> * </td> + <td class="mdname" nowrap> <em>d</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>name</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>apr_pool_t * </td> + <td class="mdname" nowrap> <em>pool</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +If file <em>name</em> exists in directory <em>d</em> return <code>TRUE</code> in <em>result</em>, otherwise return <code>FALSE</code> in <em>result</em>. +<p> +<em>pool</em> is used for all temporary allocations. </td> + </tr> +</table> +<a class="anchor" name="a4" doxytag="lcn_directory.h::lcn_directory_list"></a><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"><a class="el" href="structlcn__error__t.html">lcn_error_t</a>* lcn_directory_list </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">apr_array_header_t ** </td> + <td class="mdname" nowrap> <em>contents</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const <a class="el" href="lcn__directory_8h.html#a0">lcn_directory_t</a> * </td> + <td class="mdname" nowrap> <em>d</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>apr_pool_t * </td> + <td class="mdname" nowrap> <em>pool</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Return in <em>contents</em> a list of the files within directory <em>d</em>, allocated in <em>pool</em>. +<p> +<em>contents</em> will contain <code>const char *</code> filenames. </td> + </tr> +</table> +<a class="anchor" name="a1" doxytag="lcn_directory.h::lcn_ram_directory_open"></a><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"><a class="el" href="structlcn__error__t.html">lcn_error_t</a>* lcn_ram_directory_open </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="lcn__directory_8h.html#a0">lcn_directory_t</a> ** </td> + <td class="mdname" nowrap> <em>dir</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>apr_hash_t * </td> + <td class="mdname" nowrap> <em>contents</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>apr_pool_t * </td> + <td class="mdname" nowrap> <em>pool</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Open a new ram-backed directory <em>dir</em>, allocated within <em>pool</em>. +<p> +<em>contents</em> maps from <code>const char *</code> filenames to pointers to <code><a class="el" href="structlcn__directory__entry__t.html">lcn_directory_entry_t</a></code> objects. </td> + </tr> +</table> +<hr size="1"><address style="align: right;"><small>Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by +<a href="http://www.doxygen.org/index.html";> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.0 </small></address> +</body> +</html> Added: incubator/lucene4c/trunk/www/apidocs/lcn__document_8h-source.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__document_8h-source.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__document_8h-source.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__document_8h-source.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,73 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Lucene4c: lcn_document.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.0 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> +<div class="nav"> +<a class="el" href="dir_000000.html">include</a></div> +<h1>lcn_document.h</h1><a href="lcn__document_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/* Copyright 2005 The Apache Software Foundation or its licensors, as</span> +00002 <span class="comment"> * applicable.</span> +00003 <span class="comment"> *</span> +00004 <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span> +00005 <span class="comment"> * you may not use this file except in compliance with the License.</span> +00006 <span class="comment"> * You may obtain a copy of the License at</span> +00007 <span class="comment"> *</span> +00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span> +00009 <span class="comment"> *</span> +00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span> +00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span> +00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> +00013 <span class="comment"> * See the License for the specific language governing permissions and</span> +00014 <span class="comment"> * limitations under the License.</span> +00015 <span class="comment"> */</span> +00016 <span class="comment"></span> +00017 <span class="comment">/**</span> +00018 <span class="comment"> * @file lcn_document.h</span> +00019 <span class="comment"> * @brief Routines for manipulating lucene documents</span> +00020 <span class="comment"> */</span> +00021 +00022 <span class="preprocessor">#ifndef _LCN_DOCUMENT_H</span> +00023 <span class="preprocessor"></span><span class="preprocessor">#define _LCN_DOCUMENT_H</span> +00024 <span class="preprocessor"></span> +00025 <span class="preprocessor">#include "<a class="code" href="lcn__types_8h.html">lcn_types.h</a>"</span> +00026 <span class="preprocessor">#include "<a class="code" href="lcn__field_8h.html">lcn_field.h</a>"</span> +00027 +00028 <span class="preprocessor">#ifdef __cplusplus</span> +00029 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> { +00030 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00031 <span class="comment"></span> +00032 <span class="comment">/** Opaque structure representing a document in the index. */</span> +<a name="l00033"></a><a class="code" href="lcn__document_8h.html#a0">00033</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="lcn__document_8h.html#a0">lcn_document_t</a> <a class="code" href="lcn__document_8h.html#a0">lcn_document_t</a>; +00034 <span class="comment"></span> +00035 <span class="comment">/** Create an empty document, allocated from @a pool. */</span> +00036 <a class="code" href="lcn__document_8h.html#a0">lcn_document_t</a> * +00037 <a class="code" href="lcn__document_8h.html#a1">lcn_document_create</a> (apr_pool_t *pool); +00038 <span class="comment"></span> +00039 <span class="comment">/** Return the number of fields in document @a doc. */</span> +00040 apr_uint32_t <a class="code" href="lcn__document_8h.html#a2">lcn_document_numfields</a> (lcn_document_t *doc); +00041 <span class="comment"></span> +00042 <span class="comment">/** Add @a field to @a doc. */</span> +00043 <span class="keywordtype">void</span> <a class="code" href="lcn__document_8h.html#a3">lcn_document_add_field</a> (lcn_document_t *doc, lcn_field_t *field); +00044 <span class="comment"></span> +00045 <span class="comment">/** Return field number @a num from @a doc, or @c NULL if it does not exist. */</span> +00046 <span class="keyword">const</span> <a class="code" href="lcn__field_8h.html#a0">lcn_field_t</a> * +00047 <a class="code" href="lcn__document_8h.html#a4">lcn_document_field_by_num</a> (<span class="keyword">const</span> lcn_document_t *doc, +00048 apr_uint32_t num); +00049 <span class="comment"></span> +00050 <span class="comment">/** Return field @a name from @a doc, or @c NULL if it does not exist. */</span> +00051 <span class="keyword">const</span> <a class="code" href="lcn__field_8h.html#a0">lcn_field_t</a> * +00052 <a class="code" href="lcn__document_8h.html#a5">lcn_document_field_by_name</a> (<span class="keyword">const</span> lcn_document_t *doc, +00053 <span class="keyword">const</span> lcn_char_t *name); +00054 +00055 <span class="preprocessor">#ifdef __cplusplus</span> +00056 <span class="preprocessor"></span>} +00057 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00058 +00059 <span class="preprocessor">#endif </span><span class="comment">/* _LCN_DOCUMENT_H */</span> +</pre></div><hr size="1"><address style="align: right;"><small>Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by +<a href="http://www.doxygen.org/index.html";> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.0 </small></address> +</body> +</html> Added: incubator/lucene4c/trunk/www/apidocs/lcn__document_8h.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__document_8h.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__document_8h.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__document_8h.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,54 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Lucene4c: lcn_document.h File Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.0 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> +<div class="nav"> +<a class="el" href="dir_000000.html">include</a></div> +<h1>lcn_document.h File Reference</h1>Routines for manipulating lucene documents. <a href="#_details">More...</a> +<p> +<code>#include "<a class="el" href="lcn__types_8h-source.html">lcn_types.h</a>"</code><br> +<code>#include "<a class="el" href="lcn__field_8h-source.html">lcn_field.h</a>"</code><br> + +<p> +<a href="lcn__document_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0" doxytag="lcn_document.h::lcn_document_t"></a> +typedef <a class="el" href="lcn__document_8h.html#a0">lcn_document_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__document_8h.html#a0">lcn_document_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Opaque structure representing a document in the index. <br></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1" doxytag="lcn_document.h::lcn_document_create"></a> +<a class="el" href="lcn__document_8h.html#a0">lcn_document_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__document_8h.html#a1">lcn_document_create</a> (apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an empty document, allocated from <em>pool</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2" doxytag="lcn_document.h::lcn_document_numfields"></a> +apr_uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__document_8h.html#a2">lcn_document_numfields</a> (<a class="el" href="lcn__document_8h.html#a0">lcn_document_t</a> *doc)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of fields in document <em>doc</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3" doxytag="lcn_document.h::lcn_document_add_field"></a> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__document_8h.html#a3">lcn_document_add_field</a> (<a class="el" href="lcn__document_8h.html#a0">lcn_document_t</a> *doc, <a class="el" href="lcn__field_8h.html#a0">lcn_field_t</a> *field)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Add <em>field</em> to <em>doc</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4" doxytag="lcn_document.h::lcn_document_field_by_num"></a> +const <a class="el" href="lcn__field_8h.html#a0">lcn_field_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__document_8h.html#a4">lcn_document_field_by_num</a> (const <a class="el" href="lcn__document_8h.html#a0">lcn_document_t</a> *doc, apr_uint32_t num)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return field number <em>num</em> from <em>doc</em>, or <code>NULL</code> if it does not exist. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5" doxytag="lcn_document.h::lcn_document_field_by_name"></a> +const <a class="el" href="lcn__field_8h.html#a0">lcn_field_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__document_8h.html#a5">lcn_document_field_by_name</a> (const <a class="el" href="lcn__document_8h.html#a0">lcn_document_t</a> *doc, const <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> *name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return field <em>name</em> from <em>doc</em>, or <code>NULL</code> if it does not exist. <br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Routines for manipulating lucene documents. +<p> + +<p> +Definition in file <a class="el" href="lcn__document_8h-source.html">lcn_document.h</a>.<hr size="1"><address style="align: right;"><small>Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by +<a href="http://www.doxygen.org/index.html";> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.0 </small></address> +</body> +</html> Added: incubator/lucene4c/trunk/www/apidocs/lcn__field_8h-source.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__field_8h-source.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__field_8h-source.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__field_8h-source.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,108 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Lucene4c: lcn_field.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.0 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> +<div class="nav"> +<a class="el" href="dir_000000.html">include</a></div> +<h1>lcn_field.h</h1><a href="lcn__field_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/* Copyright 2005 The Apache Software Foundation or its licensors, as</span> +00002 <span class="comment"> * applicable.</span> +00003 <span class="comment"> *</span> +00004 <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span> +00005 <span class="comment"> * you may not use this file except in compliance with the License.</span> +00006 <span class="comment"> * You may obtain a copy of the License at</span> +00007 <span class="comment"> *</span> +00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span> +00009 <span class="comment"> *</span> +00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span> +00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span> +00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> +00013 <span class="comment"> * See the License for the specific language governing permissions and</span> +00014 <span class="comment"> * limitations under the License.</span> +00015 <span class="comment"> */</span> +00016 <span class="comment"></span> +00017 <span class="comment">/**</span> +00018 <span class="comment"> * @file lcn_field.h</span> +00019 <span class="comment"> * @brief Routines for manipulating lucene fields</span> +00020 <span class="comment"> */</span> +00021 +00022 <span class="preprocessor">#ifndef _LCN_FIELD_H</span> +00023 <span class="preprocessor"></span><span class="preprocessor">#define _LCN_FIELD_H</span> +00024 <span class="preprocessor"></span> +00025 <span class="preprocessor">#include "<a class="code" href="lcn__types_8h.html">lcn_types.h</a>"</span> +00026 +00027 <span class="preprocessor">#ifdef __cplusplus</span> +00028 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> { +00029 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00030 <span class="comment"></span> +00031 <span class="comment">/** Opaque structure representing a field in a document. */</span> +<a name="l00032"></a><a class="code" href="lcn__field_8h.html#a0">00032</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="lcn__field_8h.html#a0">lcn_field_t</a> <a class="code" href="lcn__field_8h.html#a0">lcn_field_t</a>; +00033 <span class="comment"></span> +00034 <span class="comment">/** Indicates if a field is stored in the index or not. */</span> +<a name="l00035"></a><a class="code" href="lcn__field_8h.html#a15">00035</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> { +00036 <a class="code" href="lcn__field_8h.html#a15a1">LCN_STORED_NO</a>, <span class="comment">/**< Field is not stored */</span> +00037 <a class="code" href="lcn__field_8h.html#a15a2">LCN_STORED_YES</a>, <span class="comment">/**< Field is stored */</span> +00038 <a class="code" href="lcn__field_8h.html#a15a3">LCN_STORED_COMPRESS</a> <span class="comment">/**< Field is stored in compressed form */</span> +00039 } <a class="code" href="lcn__field_8h.html#a15">lcn_field_stored_t</a>; +00040 <span class="comment"></span> +00041 <span class="comment">/** Indicates if a field is indexed or not. */</span> +<a name="l00042"></a><a class="code" href="lcn__field_8h.html#a16">00042</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> { +00043 <a class="code" href="lcn__field_8h.html#a16a4">LCN_INDEXED_NO</a>, <span class="comment">/**< Field is not indexed */</span> +00044 <a class="code" href="lcn__field_8h.html#a16a5">LCN_INDEXED_TOKENIZED</a>, <span class="comment">/**< Field is indexed in tokenized form */</span> +00045 <a class="code" href="lcn__field_8h.html#a16a6">LCN_INDEXED_UNTOKENIZED</a> <span class="comment">/**< Field is indexed without being tokenized */</span> +00046 } <a class="code" href="lcn__field_8h.html#a16">lcn_field_indexed_t</a>; +00047 <span class="comment"></span> +00048 <span class="comment">/** Indicates if a field is stored in the index's termvector. */</span> +<a name="l00049"></a><a class="code" href="lcn__field_8h.html#a17">00049</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> {<span class="comment"></span> +00050 <span class="comment"> /** Field is not stored in the termvector */</span> +00051 <a class="code" href="lcn__field_8h.html#a17a7">LCN_TERMVECTOR_NO</a>, +00052 <span class="comment"></span> +00053 <span class="comment"> /** Field is stored in the termvector */</span> +00054 <a class="code" href="lcn__field_8h.html#a17a8">LCN_TERMVECTOR_YES</a>, +00055 <span class="comment"></span> +00056 <span class="comment"> /** Field is stored in the termvector along with its positions */</span> +00057 <a class="code" href="lcn__field_8h.html#a17a9">LCN_TERMVECTOR_WITH_POSITIONS</a>, +00058 <span class="comment"></span> +00059 <span class="comment"> /** Field is stored in the termvector along with its offsets */</span> +00060 <a class="code" href="lcn__field_8h.html#a17a10">LCN_TERMVECTOR_WITH_OFFSETS</a>, +00061 <span class="comment"></span> +00062 <span class="comment"> /** Field is stored in the termvector along with its positions and offsets */</span> +00063 <a class="code" href="lcn__field_8h.html#a17a11">LCN_TERMVECTOR_WITH_POSITIONS_OFFSETS</a> +00064 } <a class="code" href="lcn__field_8h.html#a17">lcn_field_termvector_t</a>; +00065 <span class="comment"></span> +00066 <span class="comment">/** Create new field.</span> +00067 <span class="comment"> *</span> +00068 <span class="comment"> * The field will have the name @a name, the value @a value, and its status</span> +00069 <span class="comment"> * with regard to storage, indexing, and termvector are determined by the</span> +00070 <span class="comment"> * @a stored, @a indexed, and @a termvector arguments.</span> +00071 <span class="comment"> *</span> +00072 <span class="comment"> * All allocation is done with @a pool.</span> +00073 <span class="comment"> */</span> +00074 <a class="code" href="lcn__field_8h.html#a0">lcn_field_t</a> * +00075 <a class="code" href="lcn__field_8h.html#a12">lcn_field_create</a> (<span class="keyword">const</span> lcn_char_t *name, +00076 <span class="keyword">const</span> lcn_char_t *value, +00077 lcn_field_stored_t stored, +00078 lcn_field_indexed_t indexed, +00079 lcn_field_termvector_t termvector, +00080 apr_pool_t *pool); +00081 <span class="comment"></span> +00082 <span class="comment">/** Return the name of field @a f. */</span> +00083 <span class="keyword">const</span> <a class="code" href="lcn__types_8h.html#a10">lcn_char_t</a> * +00084 <a class="code" href="lcn__field_8h.html#a13">lcn_field_name</a> (<span class="keyword">const</span> lcn_field_t *f); +00085 <span class="comment"></span> +00086 <span class="comment">/** Return the content of field @a f. */</span> +00087 <span class="keyword">const</span> <a class="code" href="lcn__types_8h.html#a10">lcn_char_t</a> * +00088 <a class="code" href="lcn__field_8h.html#a14">lcn_field_content</a> (<span class="keyword">const</span> lcn_field_t *f); +00089 +00090 <span class="preprocessor">#ifdef __cplusplus</span> +00091 <span class="preprocessor"></span>} +00092 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00093 +00094 <span class="preprocessor">#endif </span><span class="comment">/* _LCN_FIELD_H */</span> +</pre></div><hr size="1"><address style="align: right;"><small>Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by +<a href="http://www.doxygen.org/index.html";> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.0 </small></address> +</body> +</html> Added: incubator/lucene4c/trunk/www/apidocs/lcn__field_8h.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__field_8h.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__field_8h.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__field_8h.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,260 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Lucene4c: lcn_field.h File Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.0 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> +<div class="nav"> +<a class="el" href="dir_000000.html">include</a></div> +<h1>lcn_field.h File Reference</h1>Routines for manipulating lucene fields. <a href="#_details">More...</a> +<p> +<code>#include "<a class="el" href="lcn__types_8h-source.html">lcn_types.h</a>"</code><br> + +<p> +<a href="lcn__field_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0" doxytag="lcn_field.h::lcn_field_t"></a> +typedef <a class="el" href="lcn__field_8h.html#a0">lcn_field_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__field_8h.html#a0">lcn_field_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Opaque structure representing a field in a document. <br></td></tr> +<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__field_8h.html#a15">lcn_field_stored_t</a> { <br> + <a class="el" href="lcn__field_8h.html#a15a1">LCN_STORED_NO</a>, +<br> + <a class="el" href="lcn__field_8h.html#a15a2">LCN_STORED_YES</a>, +<br> + <a class="el" href="lcn__field_8h.html#a15a3">LCN_STORED_COMPRESS</a> +<br> + }</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicates if a field is stored in the index or not. <a href="#a15">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__field_8h.html#a16">lcn_field_indexed_t</a> { <br> + <a class="el" href="lcn__field_8h.html#a16a4">LCN_INDEXED_NO</a>, +<br> + <a class="el" href="lcn__field_8h.html#a16a5">LCN_INDEXED_TOKENIZED</a>, +<br> + <a class="el" href="lcn__field_8h.html#a16a6">LCN_INDEXED_UNTOKENIZED</a> +<br> + }</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicates if a field is indexed or not. <a href="#a16">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__field_8h.html#a17">lcn_field_termvector_t</a> { <br> + <a class="el" href="lcn__field_8h.html#a17a7">LCN_TERMVECTOR_NO</a>, +<br> + <a class="el" href="lcn__field_8h.html#a17a8">LCN_TERMVECTOR_YES</a>, +<br> + <a class="el" href="lcn__field_8h.html#a17a9">LCN_TERMVECTOR_WITH_POSITIONS</a>, +<br> + <a class="el" href="lcn__field_8h.html#a17a10">LCN_TERMVECTOR_WITH_OFFSETS</a>, +<br> + <a class="el" href="lcn__field_8h.html#a17a11">LCN_TERMVECTOR_WITH_POSITIONS_OFFSETS</a> +<br> + }</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicates if a field is stored in the index's termvector. <a href="#a17">More...</a><br></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="lcn__field_8h.html#a0">lcn_field_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__field_8h.html#a12">lcn_field_create</a> (const <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> *name, const <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> *value, <a class="el" href="lcn__field_8h.html#a15">lcn_field_stored_t</a> stored, <a class="el" href="lcn__field_8h.html#a16">lcn_field_indexed_t</a> indexed, <a class="el" href="lcn__field_8h.html#a17">lcn_field_termvector_t</a> termvector, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create new field. <a href="#a12"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a13" doxytag="lcn_field.h::lcn_field_name"></a> +const <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__field_8h.html#a13">lcn_field_name</a> (const <a class="el" href="lcn__field_8h.html#a0">lcn_field_t</a> *f)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of field <em>f</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a14" doxytag="lcn_field.h::lcn_field_content"></a> +const <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__field_8h.html#a14">lcn_field_content</a> (const <a class="el" href="lcn__field_8h.html#a0">lcn_field_t</a> *f)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the content of field <em>f</em>. <br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Routines for manipulating lucene fields. +<p> + +<p> +Definition in file <a class="el" href="lcn__field_8h-source.html">lcn_field.h</a>.<hr><h2>Enumeration Type Documentation</h2> +<a class="anchor" name="a16" doxytag="lcn_field.h::lcn_field_indexed_t"></a><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">enum <a class="el" href="lcn__field_8h.html#a16">lcn_field_indexed_t</a> </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Indicates if a field is indexed or not. +<p> +<dl compact><dt><b>Enumeration values: </b></dt><dd> +<table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" name="a16a4" doxytag="LCN_INDEXED_NO"></a>LCN_INDEXED_NO</em> </td><td> +Field is not indexed. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="a16a5" doxytag="LCN_INDEXED_TOKENIZED"></a>LCN_INDEXED_TOKENIZED</em> </td><td> +Field is indexed in tokenized form. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="a16a6" doxytag="LCN_INDEXED_UNTOKENIZED"></a>LCN_INDEXED_UNTOKENIZED</em> </td><td> +Field is indexed without being tokenized. </td></tr> +</table> +</dl> + +<p> +Definition at line <a class="el" href="lcn__field_8h-source.html#l00042">42</a> of file <a class="el" href="lcn__field_8h-source.html">lcn_field.h</a>. </td> + </tr> +</table> +<a class="anchor" name="a15" doxytag="lcn_field.h::lcn_field_stored_t"></a><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">enum <a class="el" href="lcn__field_8h.html#a15">lcn_field_stored_t</a> </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Indicates if a field is stored in the index or not. +<p> +<dl compact><dt><b>Enumeration values: </b></dt><dd> +<table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" name="a15a1" doxytag="LCN_STORED_NO"></a>LCN_STORED_NO</em> </td><td> +Field is not stored. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="a15a2" doxytag="LCN_STORED_YES"></a>LCN_STORED_YES</em> </td><td> +Field is stored. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="a15a3" doxytag="LCN_STORED_COMPRESS"></a>LCN_STORED_COMPRESS</em> </td><td> +Field is stored in compressed form. </td></tr> +</table> +</dl> + +<p> +Definition at line <a class="el" href="lcn__field_8h-source.html#l00035">35</a> of file <a class="el" href="lcn__field_8h-source.html">lcn_field.h</a>. </td> + </tr> +</table> +<a class="anchor" name="a17" doxytag="lcn_field.h::lcn_field_termvector_t"></a><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">enum <a class="el" href="lcn__field_8h.html#a17">lcn_field_termvector_t</a> </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Indicates if a field is stored in the index's termvector. +<p> +<dl compact><dt><b>Enumeration values: </b></dt><dd> +<table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" name="a17a7" doxytag="LCN_TERMVECTOR_NO"></a>LCN_TERMVECTOR_NO</em> </td><td> +Field is not stored in the termvector. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="a17a8" doxytag="LCN_TERMVECTOR_YES"></a>LCN_TERMVECTOR_YES</em> </td><td> +Field is stored in the termvector. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="a17a9" doxytag="LCN_TERMVECTOR_WITH_POSITIONS"></a>LCN_TERMVECTOR_WITH_POSITIONS</em> </td><td> +Field is stored in the termvector along with its positions. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="a17a10" doxytag="LCN_TERMVECTOR_WITH_OFFSETS"></a>LCN_TERMVECTOR_WITH_OFFSETS</em> </td><td> +Field is stored in the termvector along with its offsets. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="a17a11" doxytag="LCN_TERMVECTOR_WITH_POSITIONS_OFFSETS"></a>LCN_TERMVECTOR_WITH_POSITIONS_OFFSETS</em> </td><td> +Field is stored in the termvector along with its positions and offsets. </td></tr> +</table> +</dl> + +<p> +Definition at line <a class="el" href="lcn__field_8h-source.html#l00049">49</a> of file <a class="el" href="lcn__field_8h-source.html">lcn_field.h</a>. </td> + </tr> +</table> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="a12" doxytag="lcn_field.h::lcn_field_create"></a><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"><a class="el" href="lcn__field_8h.html#a0">lcn_field_t</a>* lcn_field_create </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> * </td> + <td class="mdname" nowrap> <em>name</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>const <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> * </td> + <td class="mdname" nowrap> <em>value</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="lcn__field_8h.html#a15">lcn_field_stored_t</a> </td> + <td class="mdname" nowrap> <em>stored</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="lcn__field_8h.html#a16">lcn_field_indexed_t</a> </td> + <td class="mdname" nowrap> <em>indexed</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="lcn__field_8h.html#a17">lcn_field_termvector_t</a> </td> + <td class="mdname" nowrap> <em>termvector</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>apr_pool_t * </td> + <td class="mdname" nowrap> <em>pool</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Create new field. +<p> +The field will have the name <em>name</em>, the value <em>value</em>, and its status with regard to storage, indexing, and termvector are determined by the <em>stored</em>, <em>indexed</em>, and <em>termvector</em> arguments.<p> +All allocation is done with <em>pool</em>. </td> + </tr> +</table> +<hr size="1"><address style="align: right;"><small>Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by +<a href="http://www.doxygen.org/index.html";> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.0 </small></address> +</body> +</html> Added: incubator/lucene4c/trunk/www/apidocs/lcn__fielddata_8h-source.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__fielddata_8h-source.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__fielddata_8h-source.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__fielddata_8h-source.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,74 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Lucene4c: lcn_fielddata.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.0 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> +<div class="nav"> +<a class="el" href="dir_000000.html">include</a></div> +<h1>lcn_fielddata.h</h1><a href="lcn__fielddata_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/* Copyright 2005 The Apache Software Foundation or its licensors, as</span> +00002 <span class="comment"> * applicable.</span> +00003 <span class="comment"> *</span> +00004 <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span> +00005 <span class="comment"> * you may not use this file except in compliance with the License.</span> +00006 <span class="comment"> * You may obtain a copy of the License at</span> +00007 <span class="comment"> *</span> +00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span> +00009 <span class="comment"> *</span> +00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span> +00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span> +00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> +00013 <span class="comment"> * See the License for the specific language governing permissions and</span> +00014 <span class="comment"> * limitations under the License.</span> +00015 <span class="comment"> */</span> +00016 <span class="comment"></span> +00017 <span class="comment">/**</span> +00018 <span class="comment"> * @file lcn_fielddata.h</span> +00019 <span class="comment"> * @brief Routines for manipulating a segment's field data file</span> +00020 <span class="comment"> */</span> +00021 +00022 <span class="preprocessor">#ifndef _LCN_FIELDDATA_H</span> +00023 <span class="preprocessor"></span><span class="preprocessor">#define _LCN_FIELDDATA_H</span> +00024 <span class="preprocessor"></span> +00025 <span class="preprocessor">#include "<a class="code" href="lcn__types_8h.html">lcn_types.h</a>"</span> +00026 <span class="preprocessor">#include "<a class="code" href="lcn__directory_8h.html">lcn_directory.h</a>"</span> +00027 <span class="preprocessor">#include "<a class="code" href="lcn__field_8h.html">lcn_field.h</a>"</span> +00028 +00029 <span class="preprocessor">#include <apr_tables.h></span> +00030 +00031 <span class="preprocessor">#ifdef __cplusplus</span> +00032 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> { +00033 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00034 <span class="comment"></span> +00035 <span class="comment">/** Opaque structure representing a segment's field data. */</span> +<a name="l00036"></a><a class="code" href="lcn__fielddata_8h.html#a0">00036</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="lcn__fielddata_8h.html#a0">lcn_fielddata_t</a> <a class="code" href="lcn__fielddata_8h.html#a0">lcn_fielddata_t</a>; +00037 <span class="comment"></span> +00038 <span class="comment">/** Return the field data @a fd for segment @a s in directory @a d, allocated</span> +00039 <span class="comment"> * within @a pool.</span> +00040 <span class="comment"> */</span> +00041 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00042 <a class="code" href="lcn__fielddata_8h.html#a1">lcn_fielddata_open</a> (lcn_fielddata_t **fd, +00043 <span class="keyword">const</span> lcn_directory_t *d, +00044 <span class="keyword">const</span> lcn_char_t *s, +00045 apr_pool_t *pool); +00046 <span class="comment"></span> +00047 <span class="comment">/** Returns in @a doc an array of @c lcn_field_t pointers associated with</span> +00048 <span class="comment"> * document number @a doc_num, allocated within @a pool.</span> +00049 <span class="comment"> */</span> +00050 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00051 <a class="code" href="lcn__fielddata_8h.html#a2">lcn_fielddata_get_doc</a> (apr_array_header_t **doc, +00052 lcn_fielddata_t *fd, +00053 apr_uint32_t doc_num, +00054 apr_pool_t *pool); +00055 +00056 <span class="preprocessor">#ifdef __cplusplus</span> +00057 <span class="preprocessor"></span>} +00058 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00059 +00060 <span class="preprocessor">#endif</span> +</pre></div><hr size="1"><address style="align: right;"><small>Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by +<a href="http://www.doxygen.org/index.html";> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.0 </small></address> +</body> +</html> Added: incubator/lucene4c/trunk/www/apidocs/lcn__fielddata_8h.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__fielddata_8h.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__fielddata_8h.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__fielddata_8h.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,44 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Lucene4c: lcn_fielddata.h File Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.0 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> +<div class="nav"> +<a class="el" href="dir_000000.html">include</a></div> +<h1>lcn_fielddata.h File Reference</h1>Routines for manipulating a segment's field data file. <a href="#_details">More...</a> +<p> +<code>#include "<a class="el" href="lcn__types_8h-source.html">lcn_types.h</a>"</code><br> +<code>#include "<a class="el" href="lcn__directory_8h-source.html">lcn_directory.h</a>"</code><br> +<code>#include "<a class="el" href="lcn__field_8h-source.html">lcn_field.h</a>"</code><br> +<code>#include <apr_tables.h></code><br> + +<p> +<a href="lcn__fielddata_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0" doxytag="lcn_fielddata.h::lcn_fielddata_t"></a> +typedef <a class="el" href="lcn__fielddata_8h.html#a0">lcn_fielddata_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__fielddata_8h.html#a0">lcn_fielddata_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Opaque structure representing a segment's field data. <br></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1" doxytag="lcn_fielddata.h::lcn_fielddata_open"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__fielddata_8h.html#a1">lcn_fielddata_open</a> (<a class="el" href="lcn__fielddata_8h.html#a0">lcn_fielddata_t</a> **fd, const <a class="el" href="lcn__directory_8h.html#a0">lcn_directory_t</a> *d, const <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> *s, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the field data <em>fd</em> for segment <em>s</em> in directory <em>d</em>, allocated within <em>pool</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2" doxytag="lcn_fielddata.h::lcn_fielddata_get_doc"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__fielddata_8h.html#a2">lcn_fielddata_get_doc</a> (apr_array_header_t **doc, <a class="el" href="lcn__fielddata_8h.html#a0">lcn_fielddata_t</a> *fd, apr_uint32_t doc_num, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns in <em>doc</em> an array of <code>lcn_field_t</code> pointers associated with document number <em>doc_num</em>, allocated within <em>pool</em>. <br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Routines for manipulating a segment's field data file. +<p> + +<p> +Definition in file <a class="el" href="lcn__fielddata_8h-source.html">lcn_fielddata.h</a>.<hr size="1"><address style="align: right;"><small>Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by +<a href="http://www.doxygen.org/index.html";> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.0 </small></address> +</body> +</html> Added: incubator/lucene4c/trunk/www/apidocs/lcn__fieldinfos_8h-source.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__fieldinfos_8h-source.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__fieldinfos_8h-source.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__fieldinfos_8h-source.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,94 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Lucene4c: lcn_fieldinfos.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.0 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> +<div class="nav"> +<a class="el" href="dir_000000.html">include</a></div> +<h1>lcn_fieldinfos.h</h1><a href="lcn__fieldinfos_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/* Copyright 2005 The Apache Software Foundation or its licensors, as</span> +00002 <span class="comment"> * applicable.</span> +00003 <span class="comment"> *</span> +00004 <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span> +00005 <span class="comment"> * you may not use this file except in compliance with the License.</span> +00006 <span class="comment"> * You may obtain a copy of the License at</span> +00007 <span class="comment"> *</span> +00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span> +00009 <span class="comment"> *</span> +00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span> +00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span> +00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> +00013 <span class="comment"> * See the License for the specific language governing permissions and</span> +00014 <span class="comment"> * limitations under the License.</span> +00015 <span class="comment"> */</span> +00016 <span class="comment"></span> +00017 <span class="comment">/**</span> +00018 <span class="comment"> * @file lcn_fieldinfos.h</span> +00019 <span class="comment"> * @brief Routines for reading information about a segment's fields</span> +00020 <span class="comment"> */</span> +00021 +00022 <span class="preprocessor">#ifndef _LCN_FIELDINFOS_H</span> +00023 <span class="preprocessor"></span><span class="preprocessor">#define _LCN_FIELDINFOS_H</span> +00024 <span class="preprocessor"></span> +00025 <span class="preprocessor">#include "<a class="code" href="lcn__types_8h.html">lcn_types.h</a>"</span> +00026 <span class="preprocessor">#include "<a class="code" href="lcn__directory_8h.html">lcn_directory.h</a>"</span> +00027 +00028 <span class="preprocessor">#ifdef __cplusplus</span> +00029 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> { +00030 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00031 <span class="comment"></span> +00032 <span class="comment">/** Information about a particular field in a segment. */</span> +<a name="l00033"></a><a class="code" href="structlcn__fieldinfo__t.html">00033</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{<span class="comment"></span> +00034 <span class="comment"> /** The name of the field */</span> +<a name="l00035"></a><a class="code" href="structlcn__fieldinfo__t.html#o0">00035</a> <span class="keyword">const</span> <a class="code" href="lcn__types_8h.html#a10">lcn_char_t</a> *name; +00036 <span class="comment"></span> +00037 <span class="comment"> /** Is the field indexed? */</span> +<a name="l00038"></a><a class="code" href="structlcn__fieldinfo__t.html#o1">00038</a> <a class="code" href="lcn__types_8h.html#a8">lcn_boolean_t</a> is_indexed; +00039 <span class="comment"></span> +00040 <span class="comment"> /** The field's number */</span> +<a name="l00041"></a><a class="code" href="structlcn__fieldinfo__t.html#o2">00041</a> apr_int32_t number; +00042 <span class="comment"></span> +00043 <span class="comment"> /** Is the field stored in the term vector? */</span> +<a name="l00044"></a><a class="code" href="structlcn__fieldinfo__t.html#o3">00044</a> <a class="code" href="lcn__types_8h.html#a8">lcn_boolean_t</a> store_term_vector; +00045 } <a class="code" href="structlcn__fieldinfo__t.html">lcn_fieldinfo_t</a>; +00046 <span class="comment"></span> +00047 <span class="comment">/** Opaque structure representing a segment's fieldinfos file. */</span> +<a name="l00048"></a><a class="code" href="lcn__fieldinfos_8h.html#a0">00048</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="lcn__fieldinfos_8h.html#a0">lcn_fieldinfos_t</a> <a class="code" href="lcn__fieldinfos_8h.html#a0">lcn_fieldinfos_t</a>; +00049 <span class="comment"></span> +00050 <span class="comment">/** Return in @a fis an @c lcn_fieldinfos_t corresponding to segment @a s in</span> +00051 <span class="comment"> * directory @a d, allocated in @a pool.</span> +00052 <span class="comment"> */</span> +00053 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00054 <a class="code" href="lcn__fieldinfos_8h.html#a1">lcn_fieldinfos_read</a> (lcn_fieldinfos_t **fis, +00055 <span class="keyword">const</span> lcn_directory_t *d, +00056 <span class="keyword">const</span> lcn_char_t *s, +00057 apr_pool_t *pool); +00058 <span class="comment"></span> +00059 <span class="comment">/** Return a pointer to the @c lcn_fieldinfo_t that corresponds to number</span> +00060 <span class="comment"> * @a i, or @c NULL if none exists.</span> +00061 <span class="comment"> */</span> +00062 <a class="code" href="structlcn__fieldinfo__t.html">lcn_fieldinfo_t</a> * +00063 <a class="code" href="lcn__fieldinfos_8h.html#a2">lcn_fieldinfos_get_by_number</a> (<span class="keyword">const</span> lcn_fieldinfos_t *fis, +00064 <span class="keywordtype">int</span> i); +00065 <span class="comment"></span> +00066 <span class="comment">/** Return a pointer to the @c lcn_fieldinfo_t that corresponds to @a name,</span> +00067 <span class="comment"> * or @c NULL if none exists.</span> +00068 <span class="comment"> */</span> +00069 <a class="code" href="structlcn__fieldinfo__t.html">lcn_fieldinfo_t</a> * +00070 <a class="code" href="lcn__fieldinfos_8h.html#a3">lcn_fieldinfos_get_by_name</a> (<span class="keyword">const</span> lcn_fieldinfos_t *fis, +00071 <span class="keyword">const</span> lcn_char_t *name); +00072 <span class="comment"></span> +00073 <span class="comment">/** Return the number of fieldinfos within @a fis */</span> +00074 <span class="keywordtype">int</span> <a class="code" href="lcn__fieldinfos_8h.html#a4">lcn_fieldinfos_get_count</a> (<span class="keyword">const</span> lcn_fieldinfos_t *fis); +00075 +00076 <span class="preprocessor">#ifdef __cplusplus</span> +00077 <span class="preprocessor"></span>} +00078 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00079 +00080 <span class="preprocessor">#endif</span> +</pre></div><hr size="1"><address style="align: right;"><small>Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by +<a href="http://www.doxygen.org/index.html";> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.0 </small></address> +</body> +</html>
