Click or drag to resize

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 Hierarchy

Namespace:  Alphaleonis.Win32.Filesystem
Assembly:  AlphaFS (in AlphaFS.dll) Version: 2.2
Syntax
public sealed class BackupFileStream : Stream

The BackupFileStream type exposes the following members.

Constructors
  NameDescription
Public methodBackupFileStream(SafeFileHandle, FileSystemRights)
Initializes a new instance of the BackupFileStream class for the specified file handle, with the specified read/write permission.
Public methodBackupFileStream(String, FileMode)
Initializes a new instance of the BackupFileStream class with the specified path and creation mode.
Public methodBackupFileStream(String, FileMode, FileSystemRights)
Initializes a new instance of the BackupFileStream class with the specified path, creation mode and access rights.
Public methodBackupFileStream(KernelTransaction, String, FileMode)
Initializes a new instance of the BackupFileStream class with the specified path and creation mode.
Public methodBackupFileStream(String, FileMode, FileSystemRights, FileShare)
Initializes a new instance of the BackupFileStream class with the specified path, creation mode, access rights and sharing permission.
Public methodBackupFileStream(KernelTransaction, String, FileMode, FileSystemRights)
Initializes a new instance of the BackupFileStream class with the specified path, creation mode and access rights.
Public methodBackupFileStream(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.
Public methodBackupFileStream(KernelTransaction, String, FileMode, FileSystemRights, FileShare)
Initializes a new instance of the BackupFileStream class with the specified path, creation mode, access rights and sharing permission.
Public methodBackupFileStream(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.
Public methodBackupFileStream(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.
Public methodBackupFileStream(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.
Top
Properties
  NameDescription
Public propertyCanRead
Gets a value indicating whether the current stream supports reading.
(Overrides StreamCanRead.)
Public propertyCanSeek
Gets a value indicating whether the current stream supports seeking.
(Overrides StreamCanSeek.)
Public propertyCanTimeout
Gets a value that determines whether the current stream can time out.
(Inherited from Stream.)
Public propertyCanWrite
Gets a value indicating whether the current stream supports writing.
(Overrides StreamCanWrite.)
Public propertyLength
When overridden in a derived class, gets the length in bytes of the stream.
(Overrides StreamLength.)
Public propertyPosition
When overridden in a derived class, gets or sets the position within the current stream.
(Overrides StreamPosition.)
Public propertyReadTimeout
Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out.
(Inherited from Stream.)
Public propertyWriteTimeout
Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out.
(Inherited from Stream.)
Top
Methods
  NameDescription
Public methodBeginRead
Begins an asynchronous read operation.
(Inherited from Stream.)
Public methodBeginWrite
Begins an asynchronous write operation.
(Inherited from Stream.)
Public methodClose
Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.
(Inherited from Stream.)
Public methodCopyTo(Stream)
Reads the bytes from the current stream and writes them to the destination stream.
(Inherited from Stream.)
Public methodCopyTo(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.)
Public methodCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
Protected methodCreateWaitHandle Obsolete.
Allocates a WaitHandle object.
(Inherited from Stream.)
Public methodDispose
Releases all resources used by the Stream.
(Inherited from Stream.)
Protected methodDispose(Boolean)
Releases the unmanaged resources used by the Stream and optionally releases the managed resources.
(Overrides StreamDispose(Boolean).)
Public methodEndRead
Waits for the pending asynchronous read to complete.
(Inherited from Stream.)
Public methodEndWrite
Ends an asynchronous write operation.
(Inherited from Stream.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Releases unmanaged resources and performs other cleanup operations before the BackupFileStream is reclaimed by garbage collection.
(Overrides ObjectFinalize.)
Public methodFlush
Clears all buffers for this stream and causes any buffered data to be written to the underlying device.
(Overrides StreamFlush.)
Public methodGetAccessControl
Gets a FileSecurity object that encapsulates the access control list (ACL) entries for the file described by the current BackupFileStream object.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public methodLock
Prevents other processes from changing the BackupFileStream while permitting read access.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodMemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
Protected methodObjectInvariant
Provides support for a Contract.
(Inherited from Stream.)
Public methodRead(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).)
Public methodRead(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.
Public methodReadByte
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.)
Public methodReadStreamInfo
Reads a stream header from the current BackupFileStream.
Public methodSeek
When overridden in a derived class, sets the position within the current stream.
(Overrides StreamSeek(Int64, SeekOrigin).)
Public methodSetAccessControl
Applies access control list (ACL) entries described by a FileSecurity object to the file described by the current BackupFileStream object.
Public methodSetLength
When overridden in a derived class, sets the length of the current stream.
(Overrides StreamSetLength(Int64).)
Public methodSkip
Skips ahead the specified number of bytes from the current stream.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUnlock
Allows access by other processes to all or part of a file that was previously locked.
Public methodWrite(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).)
Public methodWrite(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.
Public methodWriteByte
Writes a byte to the current position in the stream and advances the position within the stream by one byte.
(Inherited from Stream.)
Top
Remarks
This class uses the BackupRead, BackupSeek and BackupWrite functions from the Win32 API to provide access to the file or directory.
See Also