XsWin32FileStream Class |  |
This class is used for Shared diskaccess on Windows.
Inheritance HierarchyNamespace: XSharp.IO
Assembly: XSharp.Core (in XSharp.Core.dll) Version: 2.19
SyntaxThe XsWin32FileStream type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | FileName | The name of the file opened in the stream. (Inherited from XsFileStream.) |
| Length | Gets the length in bytes of the stream. (Overrides Length.) |
Methods| Name | Description | |
|---|---|---|
 | Flush | Clears buffers for this stream and causes any buffered data to be written to the file. (Overrides Flush.) |
| Flush(Logic) | Clears buffers for this stream and causes any buffered data to be written to the file, and also clears all intermediate file buffers. (Overrides Flush(Logic).) |
| Lock | Prevents other processes from reading from or writing to the FileStream. (Overrides Lock(Int64, Int64).) |
| Read | Reads a block of bytes from the stream and writes the data in a given buffer. (Overrides Read(Byte, Long, Long).) |
| Seek | Sets the current position of this stream to the given value. (Overrides Seek(Int64, SeekOrigin).) |
| SetLength | Sets the length of this stream to the given value. (Overrides SetLength(Int64).) |
| Unlock | Allows access by other processes to all or part of a file that was previously locked. (Overrides Unlock(Int64, Int64).) |
| Write | Writes a block of bytes to the file stream. (Overrides Write(Byte, Long, Long).) |
| WriteByte | Writes a byte to the current position in the file stream. (Overrides WriteByte(Byte).) |
Extension Methods| Name | Description | |
|---|---|---|
 | SafeLock | Locks a region in a stream. Contains TRY CATCH mechanism. (Defined by FileStreamExensions.) |
| SafeRead(Byte) | Overloaded. Read data from a stream. Assumes that the whole buffer must be read. Reads from current location. (Defined by FileStreamExensions.) |
| SafeRead(Byte, Long) | Overloaded. Read data from a stream. Contains TRY CATCH mechanism. Reads from current location. (Defined by FileStreamExensions.) |
| SafeRead(Byte, Long, Long) | Overloaded. Read data from a stream. Contains TRY CATCH mechanism. Reads from current location. (Defined by FileStreamExensions.) |
| SafeReadAt(Int64, Byte) | Overloaded. Read data at a location in the file. Makes sure that file locations are >= 0. Assumes whole buffer must be read. (Defined by FileStreamExensions.) |
| SafeReadAt(Int64, Byte, Long) | Overloaded. Read data at a location in the file. Makes sure that file locations are >= 0 (Defined by FileStreamExensions.) |
| SafeSetLength | Sets the length of a stream. Contains TRY CATCH mechanism. (Defined by FileStreamExensions.) |
| SafeSetPos | Sets the location of a stream. Contains TRY CATCH mechanism. . (Defined by FileStreamExensions.) |
| SafeUnlock | Unlocks a region in a stream. Contains TRY CATCH mechanism. (Defined by FileStreamExensions.) |
| SafeWrite(Byte) | Overloaded. Write data to a stream. Contains TRY CATCH mechanism. Writes to the current location. Assumes the whole buffer must be written. (Defined by FileStreamExensions.) |
| SafeWrite(Byte, Long) | Overloaded. Write data to a stream. Contains TRY CATCH mechanism. Writes to the current location. (Defined by FileStreamExensions.) |
| SafeWriteAt(Int64, Byte) | Overloaded. Write data at a location in the file. Makes sure that file locations are >= 0. Assumes whole buffer must be written. (Defined by FileStreamExensions.) |
| SafeWriteAt(Int64, Byte, Long) | Overloaded. Write data at a location in the file. Makes sure that file locations are >= 0. (Defined by FileStreamExensions.) |
| SafeWriteByte | Write data to a stream. Contains TRY CATCH mechanism. Writes to the current location. (Defined by FileStreamExensions.) |
RemarksThe class bypasses some of the default methods in the FileStraem class and directly uses calls to OS functions to make
sure that changes made by other users are visible and not hidden because of caching in the .Net FileStream class.
See Also