blob: 1592230b570cd3f702995f8a96f24c4d3429ac46 [file] [log] [blame]
<html dir="LTR">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252" />
<meta name="vs_targetSchema" content="http://schemas.microsoft.com/intellisense/ie5" />
<title>MMapDirectory Methods</title>
<xml>
</xml>
<link rel="stylesheet" type="text/css" href="MSDN.css" />
</head>
<body id="bodyID" class="dtBODY">
<div id="nsbanner">
<div id="bannerrow1">
<table class="bannerparthead" cellspacing="0">
<tr id="hdr">
<td class="runninghead">Apache Lucene.Net 2.4.0 Class Library API</td>
<td class="product">
</td>
</tr>
</table>
</div>
<div id="TitleRow">
<h1 class="dtH1">MMapDirectory Methods</h1>
</div>
</div>
<div id="nstext">
<p>The methods of the <b>MMapDirectory</b> class are listed below. For a complete list of <b>MMapDirectory</b> class members, see the <a href="Lucene.Net.Store.MMapDirectoryMembers.html">MMapDirectory Members</a> topic.</p>
<h4 class="dtH4">Public Instance Methods</h4>
<div class="tablediv">
<table class="dtTABLE" cellspacing="0">
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="Lucene.Net.Store.Directory.ClearLock.html">ClearLock</a> (inherited from <b>Directory</b>)</td><td width="50%"> Attempt to clear (forcefully unlock and remove) the specified lock. Only call this at a time when you are certain this lock is no longer in use. </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="Lucene.Net.Store.FSDirectory.Close.html">Close</a> (inherited from <b>FSDirectory</b>)</td><td width="50%">Closes the store to future operations. </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="Lucene.Net.Store.FSDirectory.CreateOutput.html">CreateOutput</a> (inherited from <b>FSDirectory</b>)</td><td width="50%">Creates a new, empty file in the directory with the given name. Returns a stream writing this file. </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="Lucene.Net.Store.FSDirectory.DeleteFile.html">DeleteFile</a> (inherited from <b>FSDirectory</b>)</td><td width="50%">Removes an existing file in the directory. </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemObjectClassEqualsTopic.htm">Equals</a> (inherited from <b>Object</b>)</td><td width="50%">Determines whether the specified <a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemObjectClassTopic.htm">Object</a> is equal to the current <a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemObjectClassTopic.htm">Object</a>.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="Lucene.Net.Store.FSDirectory.FileExists.html">FileExists</a> (inherited from <b>FSDirectory</b>)</td><td width="50%">Returns true iff a file with the given name exists. </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="Lucene.Net.Store.FSDirectory.FileLength.html">FileLength</a> (inherited from <b>FSDirectory</b>)</td><td width="50%">Returns the length in bytes of a file in the directory. </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="Lucene.Net.Store.FSDirectory.FileModified_overload_1.html">FileModified</a> (inherited from <b>FSDirectory</b>)</td><td width="50%">Returns the time the named file was last modified. </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="Lucene.Net.Store.FSDirectory.GetFile.html">GetFile</a> (inherited from <b>FSDirectory</b>)</td><td width="50%"> </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemObjectClassGetHashCodeTopic.htm">GetHashCode</a> (inherited from <b>Object</b>)</td><td width="50%">Serves as a hash function for a particular type. <b>GetHashCode</b> is suitable for use in hashing algorithms and data structures like a hash table.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="Lucene.Net.Store.Directory.GetLockFactory.html">GetLockFactory</a> (inherited from <b>Directory</b>)</td><td width="50%"> Get the LockFactory that this Directory instance is using for its locking implementation. Note that this may be null for Directory implementations that provide their own locking implementation. </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="Lucene.Net.Store.FSDirectory.GetLockID.html">GetLockID</a> (inherited from <b>FSDirectory</b>)</td><td width="50%"> </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemObjectClassGetTypeTopic.htm">GetType</a> (inherited from <b>Object</b>)</td><td width="50%">Gets the <a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemTypeClassTopic.htm">Type</a> of the current instance.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="Lucene.Net.Store.FSDirectory.List.html">List</a> (inherited from <b>FSDirectory</b>)</td><td width="50%">Returns an array of strings, one for each Lucene index file in the directory. </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="Lucene.Net.Store.Directory.MakeLock.html">MakeLock</a> (inherited from <b>Directory</b>)</td><td width="50%">Construct a {@link Lock}.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="Lucene.Net.Store.MMapDirectory.OpenInput_overloads.html">OpenInput</a></td><td width="50%">Overloaded.  </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="Lucene.Net.Store.FSDirectory.RenameFile.html">RenameFile</a> (inherited from <b>FSDirectory</b>)</td><td width="50%">Renames an existing file in the directory. Warning: This is not atomic. </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="Lucene.Net.Store.Directory.SetLockFactory.html">SetLockFactory</a> (inherited from <b>Directory</b>)</td><td width="50%"> Set the LockFactory that this Directory instance should use for its locking implementation. Each * instance of LockFactory should only be used for one directory (ie, do not share a single instance across multiple Directories). </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="Lucene.Net.Store.FSDirectory.Sync.html">Sync</a> (inherited from <b>FSDirectory</b>)</td><td width="50%"> </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="Lucene.Net.Store.FSDirectory.ToString.html">ToString</a> (inherited from <b>FSDirectory</b>)</td><td width="50%">For debug output. </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="Lucene.Net.Store.FSDirectory.TouchFile.html">TouchFile</a> (inherited from <b>FSDirectory</b>)</td><td width="50%">Set the modified time of an existing file to now. </td></tr></table>
</div>
<h4 class="dtH4">Protected Instance Methods</h4>
<div class="tablediv">
<table class="dtTABLE" cellspacing="0">
<tr VALIGN="top"><td width="50%"><img src="protmethod.gif"></img><a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemObjectClassFinalizeTopic.htm">Finalize</a> (inherited from <b>Object</b>)</td><td width="50%">Allows an <a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemObjectClassTopic.htm">Object</a> to attempt to free resources and perform other cleanup operations before the <a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemObjectClassTopic.htm">Object</a> is reclaimed by garbage collection.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="protmethod.gif"></img><a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemObjectClassMemberwiseCloneTopic.htm">MemberwiseClone</a> (inherited from <b>Object</b>)</td><td width="50%">Creates a shallow copy of the current <a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemObjectClassTopic.htm">Object</a>.</td></tr></table>
</div>
<h4 class="dtH4">Protected Internal Instance Methods</h4>
<div class="tablediv">
<table class="dtTABLE" cellspacing="0">
<tr VALIGN="top"><td width="50%"><img src="intmethod.gif"></img><a href="Lucene.Net.Store.Directory.EnsureOpen.html">EnsureOpen</a> (inherited from <b>Directory</b>)</td><td width="50%"> Throws AlreadyClosedException if this Directory is closed. </td></tr></table>
</div>
<h4 class="dtH4">See Also</h4>
<p>
<a href="Lucene.Net.Store.MMapDirectory.html">MMapDirectory Class</a> | <a href="Lucene.Net.Store.html">Lucene.Net.Store Namespace</a></p>
<object type="application/x-oleobject" classid="clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e" viewastext="true" style="display: none;">
<param name="Keyword" value="MMapDirectory class, methods">
</param>
</object>
<hr />
<div id="footer">
<p>
</p>
<p>Generated from assembly Lucene.Net [2.4.0.2]</p>
</div>
</div>
</body>
</html>