| BackupFileStream Class |
The BackupFileStream provides access to data associated with a specific file or directory, including security information and alternative data streams, for backup and restore operations.
Inheritance HierarchyNamespace: Alphaleonis.Win32.Filesystem
Assembly: AlphaFS (in AlphaFS.dll) Version: 2.0
SyntaxThe BackupFileStream type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BackupFileStream(SafeFileHandle, FileSystemRights) | Initializes a new instance of the BackupFileStream class for the specified file handle, with the specified read/write permission. |
| BackupFileStream(String, FileMode) | Initializes a new instance of the BackupFileStream class with the specified path and creation mode. |
| BackupFileStream(String, FileMode, FileSystemRights) | Initializes a new instance of the BackupFileStream class with the specified path, creation mode and access rights. |
| BackupFileStream(KernelTransaction, String, FileMode) | Initializes a new instance of the BackupFileStream class with the specified path and creation mode. |
| BackupFileStream(String, FileMode, FileSystemRights, FileShare) | Initializes a new instance of the BackupFileStream class with the specified path, creation mode, access rights and sharing permission. |
| BackupFileStream(KernelTransaction, String, FileMode, FileSystemRights) | Initializes a new instance of the BackupFileStream class with the specified path, creation mode and access rights. |
| BackupFileStream(String, FileMode, FileSystemRights, FileShare, ExtendedFileAttributes) | Initializes a new instance of the BackupFileStream class with the specified path, creation mode, access rights and sharing permission, and additional file attributes. |
| BackupFileStream(KernelTransaction, String, FileMode, FileSystemRights, FileShare) | Initializes a new instance of the BackupFileStream class with the specified path, creation mode, access rights and sharing permission. |
| BackupFileStream(String, FileMode, FileSystemRights, FileShare, ExtendedFileAttributes, FileSecurity) | Initializes a new instance of the BackupFileStream class with the specified path, creation mode, access rights and sharing permission, additional file attributes, access control and audit security. |
| BackupFileStream(KernelTransaction, String, FileMode, FileSystemRights, FileShare, ExtendedFileAttributes) | Initializes a new instance of the BackupFileStream class with the specified path, creation mode, access rights and sharing permission, and additional file attributes. |
| BackupFileStream(KernelTransaction, String, FileMode, FileSystemRights, FileShare, ExtendedFileAttributes, FileSecurity) | Initializes a new instance of the BackupFileStream class with the specified path, creation mode, access rights and sharing permission, additional file attributes, access control and audit security. |
Methods| Name | Description | |
|---|---|---|
| BeginRead | Begins an asynchronous read operation. (Inherited from Stream.) |
| BeginWrite | Begins an asynchronous write operation. (Inherited from Stream.) |
| Close | Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. (Inherited from Stream.) |
| CopyTo(Stream) | Reads the bytes from the current stream and writes them to the destination stream. (Inherited from Stream.) |
| CopyTo(Stream, Int32) | Reads all the bytes from the current stream and writes them to a destination stream, using a specified buffer size. (Inherited from Stream.) |
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
 | CreateWaitHandle | Obsolete. Allocates a WaitHandle object. (Inherited from Stream.) |
| Dispose | Releases all resources used by the Stream. (Inherited from Stream.) |
| Dispose(Boolean) |
Releases the unmanaged resources used by the Stream and optionally releases the managed resources.
(Overrides StreamDispose(Boolean).) |
| EndRead | Waits for the pending asynchronous read to complete. (Inherited from Stream.) |
| EndWrite | Ends an asynchronous write operation. (Inherited from Stream.) |
| Equals | (Inherited from Object.) |
| Finalize | Releases unmanaged resources and performs other cleanup operations before the BackupFileStream is reclaimed by garbage collection. (Overrides ObjectFinalize.) |
| Flush | Clears all buffers for this stream and causes any buffered data to be written to the underlying device. (Overrides StreamFlush.) |
| GetAccessControl |
Gets a FileSecurity object that encapsulates the access control list (ACL) entries for the file described by the
current BackupFileStream object.
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| Lock | Prevents other processes from changing the BackupFileStream while permitting read access. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
| ObjectInvariant | Provides support for a Contract. (Inherited from Stream.) |
| Read(Byte, Int32, Int32) |
Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
(Overrides StreamRead(Byte, Int32, Int32).) |
| Read(Byte, Int32, Int32, Boolean) | When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. |
| ReadByte | Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream. (Inherited from Stream.) |
| ReadStreamInfo |
Reads a stream header from the current BackupFileStream.
|
| Seek | When overridden in a derived class, sets the position within the current stream. (Overrides StreamSeek(Int64, SeekOrigin).) |
| SetAccessControl |
Applies access control list (ACL) entries described by a FileSecurity object to the file described by the current
BackupFileStream object.
|
| SetLength | When overridden in a derived class, sets the length of the current stream. (Overrides StreamSetLength(Int64).) |
| Skip | Skips ahead the specified number of bytes from the current stream. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Unlock | Allows access by other processes to all or part of a file that was previously locked. |
| Write(Byte, Int32, Int32) | Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. (Overrides StreamWrite(Byte, Int32, Int32).) |
| Write(Byte, Int32, Int32, Boolean) | When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. |
| WriteByte | Writes a byte to the current position in the stream and advances the position within the stream by one byte. (Inherited from Stream.) |
Properties| Name | Description | |
|---|---|---|
 | CanRead | Gets a value indicating whether the current stream supports reading. (Overrides StreamCanRead.) |
| CanSeek | Gets a value indicating whether the current stream supports seeking. (Overrides StreamCanSeek.) |
| CanTimeout | Gets a value that determines whether the current stream can time out. (Inherited from Stream.) |
| CanWrite | Gets a value indicating whether the current stream supports writing. (Overrides StreamCanWrite.) |
| Length | When overridden in a derived class, gets the length in bytes of the stream. (Overrides StreamLength.) |
| Position | When overridden in a derived class, gets or sets the position within the current stream. (Overrides StreamPosition.) |
| ReadTimeout | Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out. (Inherited from Stream.) |
| SafeFileHandle | Gets a SafeFileHandle object that represents the operating system file handle for the file that the current BackupFileStream object encapsulates. |
| WriteTimeout | Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out. (Inherited from Stream.) |
RemarksThis class uses the BackupRead,
BackupSeek and
BackupWrite functions from the Win32 API to provide access to the file or directory.
See Also