| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.3"/> |
| <title>Lucene.Net: Lucene.Net.Support.FileSupport Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { searchBox.OnSelectItem(0); }); |
| </script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectlogo"><img alt="Logo" src="lucene-net-icon-128x128.png"/></td> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">Lucene.Net |
|  <span id="projectnumber">3.0.3</span> |
| </div> |
| <div id="projectbrief">Lucene.Net is a .NET port of the Java Lucene Indexing Library</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.3 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="Index.html"><span>Main Page</span></a></li> |
| <li><a href="namespaces.html"><span>Packages</span></a></li> |
| <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| <li><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.png" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="annotated.html"><span>Class List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class Members</span></a></li> |
| </ul> |
| </div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Properties</a></div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_support.html">Support</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_support_1_1_file_support.html">FileSupport</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="class_lucene_1_1_net_1_1_support_1_1_file_support-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Support.FileSupport Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Represents the methods to support some operations over files. |
| <a href="class_lucene_1_1_net_1_1_support_1_1_file_support.html#details">More...</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:ac75dc3d5298b2772e57dbffaf0c09f61"><td class="memItemLeft" align="right" valign="top">static System.IO.FileInfo[] </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_support_1_1_file_support.html#ac75dc3d5298b2772e57dbffaf0c09f61">GetFiles</a> (System.IO.FileInfo path)</td></tr> |
| <tr class="memdesc:ac75dc3d5298b2772e57dbffaf0c09f61"><td class="mdescLeft"> </td><td class="mdescRight">Returns an array of abstract pathnames representing the files and directories of the specified path. <a href="#ac75dc3d5298b2772e57dbffaf0c09f61"></a><br/></td></tr> |
| <tr class="separator:ac75dc3d5298b2772e57dbffaf0c09f61"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4a41b0c65e836154145593d9970d4394"><td class="memItemLeft" align="right" valign="top">static System.IO.FileInfo[] </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_support_1_1_file_support.html#a4a41b0c65e836154145593d9970d4394">GetFiles</a> (System.IO.DirectoryInfo path)</td></tr> |
| <tr class="separator:a4a41b0c65e836154145593d9970d4394"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acb3bbfe89c81a5843fee7adad06bb2ca"><td class="memItemLeft" align="right" valign="top">static System.String[] </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_support_1_1_file_support.html#acb3bbfe89c81a5843fee7adad06bb2ca">GetLuceneIndexFiles</a> (System.String fullName, <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_file_name_filter.html">Index.IndexFileNameFilter</a> indexFileNameFilter)</td></tr> |
| <tr class="memdesc:acb3bbfe89c81a5843fee7adad06bb2ca"><td class="mdescLeft"> </td><td class="mdescRight">Returns a list of files in a give directory. <a href="#acb3bbfe89c81a5843fee7adad06bb2ca"></a><br/></td></tr> |
| <tr class="separator:acb3bbfe89c81a5843fee7adad06bb2ca"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae93d811262769a86ab5e4b765a25d7bf"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_support_1_1_file_support.html#ae93d811262769a86ab5e4b765a25d7bf">Sync</a> (System.IO.FileStream fileStream)</td></tr> |
| <tr class="memdesc:ae93d811262769a86ab5e4b765a25d7bf"><td class="mdescLeft"> </td><td class="mdescRight">Flushes the specified file stream. Ensures that all buffered data is actually written to the file system. <a href="#ae93d811262769a86ab5e4b765a25d7bf"></a><br/></td></tr> |
| <tr class="separator:ae93d811262769a86ab5e4b765a25d7bf"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Represents the methods to support some operations over files. </p> |
| |
| <p>Definition at line <a class="el" href="_file_support_8cs_source.html#l00030">30</a> of file <a class="el" href="_file_support_8cs_source.html">FileSupport.cs</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="ac75dc3d5298b2772e57dbffaf0c09f61"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static System.IO.FileInfo [] Lucene.Net.Support.FileSupport.GetFiles </td> |
| <td>(</td> |
| <td class="paramtype">System.IO.FileInfo </td> |
| <td class="paramname"><em>path</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns an array of abstract pathnames representing the files and directories of the specified path. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">path</td><td>The abstract pathname to list it childs.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>An array of abstract pathnames childs of the path specified or null if the path is not a directory</dd></dl> |
| |
| <p>Definition at line <a class="el" href="_file_support_8cs_source.html#l00037">37</a> of file <a class="el" href="_file_support_8cs_source.html">FileSupport.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a4a41b0c65e836154145593d9970d4394"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static System.IO.FileInfo [] Lucene.Net.Support.FileSupport.GetFiles </td> |
| <td>(</td> |
| <td class="paramtype">System.IO.DirectoryInfo </td> |
| <td class="paramname"><em>path</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_file_support_8cs_source.html#l00053">53</a> of file <a class="el" href="_file_support_8cs_source.html">FileSupport.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="acb3bbfe89c81a5843fee7adad06bb2ca"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static System.String [] Lucene.Net.Support.FileSupport.GetLuceneIndexFiles </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>fullName</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_file_name_filter.html">Index.IndexFileNameFilter</a> </td> |
| <td class="paramname"><em>indexFileNameFilter</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a list of files in a give directory. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">fullName</td><td>The full path name to the directory.</td></tr> |
| <tr><td class="paramname">indexFileNameFilter</td><td></td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>An array containing the files.</dd></dl> |
| |
| <p>Definition at line <a class="el" href="_file_support_8cs_source.html#l00064">64</a> of file <a class="el" href="_file_support_8cs_source.html">FileSupport.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ae93d811262769a86ab5e4b765a25d7bf"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static void Lucene.Net.Support.FileSupport.Sync </td> |
| <td>(</td> |
| <td class="paramtype">System.IO.FileStream </td> |
| <td class="paramname"><em>fileStream</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Flushes the specified file stream. Ensures that all buffered data is actually written to the file system. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">fileStream</td><td>The file stream.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_file_support_8cs_source.html#l00090">90</a> of file <a class="el" href="_file_support_8cs_source.html">FileSupport.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>core/Support/<a class="el" href="_file_support_8cs_source.html">FileSupport.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:59 for Lucene.Net by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.3 |
| </small></address> |
| </body> |
| </html> |
