SnapDB Library
File
Contains the information that is in the header page of an archive file.
Definition
Namespace: SnapDB.IO.FileStructure
Assembly: SnapDB (in SnapDB.dll) Version: 1.0.102.0 -- Release Build+29075351d0e5aa4dea46a5c520805222f672dc2e
Assembly: SnapDB (in SnapDB.dll) Version: 1.0.102.0 -- Release Build+29075351d0e5aa4dea46a5c520805222f672dc2e
C#
public class FileHeaderBlock : ImmutableObjectBase<FileHeaderBlock>VB
Public Class FileHeaderBlock
Inherits ImmutableObjectBase(Of FileHeaderBlock)C++
public ref class FileHeaderBlock : public ImmutableObjectBase<FileHeaderBlock^>JavaScript
SnapDB.IO.FileStructure.FileHeaderBlock = function();
Type.createClass(
'SnapDB.IO.FileStructure.FileHeaderBlock',
SnapDB.Immutables.ImmutableObjectBase`1);- Inheritance
- Object ImmutableObjectBaseFileHeaderBlock FileHeaderBlock
Properties
| ArchiveId | The GUID number for this archive. |
| ArchiveType | The GUID number for this archive. |
| BlockSize | The number of bytes per block for the file structure. |
| CanRead | Determines if the archive file can be read |
| CanWrite | Determines if the file can be written to because enough features are recognized by this current version to do it without corrupting the file system. |
| DataBlockSize | Gets the size of each data block (block size - overhead) |
| FileCount | Returns the number of files that are in this file system. |
| Files | A list of all of the files in this collection. |
| Flags | User definable flags to associate with archive files. |
| HeaderBlockCount | Gets the number of times the file header exists in the archive file. |
| IsReadOnly |
Gets or sets if this class is immutable and thus read-only. Once
setting to read-only, the class becomes immutable.
(Inherited from ImmutableObjectBaseT) |
| IsSimplifiedFileFormat | Gets if this file uses the simplified file format. |
| LastAllocatedBlock | Represents the last block that has been allocated. |
| SnapshotSequenceNumber | Maintains a sequential number that represents the version of the file. |
Methods
| AllocateFreeBlocks | Allocates a sequential number of blocks at the end of the file and returns the starting address of the allocation |
| Clone |
Creates a clone of the object, either as a read-only instance or an editable one.
(Inherited from ImmutableObjectBaseT) |
| CloneEditable |
Clones the object, while incrementing the sequence number.
(Overrides ImmutableObjectBaseTCloneEditable) |
| CloneMembersAsEditable |
Request that member fields be cloned and marked as editable.
(Overrides ImmutableObjectBaseTCloneMembersAsEditable) |
| CloneReadonly |
Creates a read-only clone of the object.
(Inherited from ImmutableObjectBaseT) |
| ContainsSubFile | Determines if the file contains the subfile |
| CreateNew | Creates a new file header. |
| CreateNewFile | Creates a new file on the file system and returns the SubFileHeader associated with the new file. |
| CreateNewSimplified | Creates a new simplified FileHeaderBlock with the specified blockSize and optional flags. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetBytes | Gets the binary representation of the file allocation table. |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| Open | Opens an existing FileHeaderBlock from the provided binary data. |
| SearchForBlockSize | Looks in the contents of a file for the block size of the file. |
| SetMembersAsReadOnly |
Requests that member fields be set to readonly.
(Overrides ImmutableObjectBaseTSetMembersAsReadOnly) |
| TestForEditable |
Test if the class has been marked as read-only. Throws an exception if editing cannot occur.
(Inherited from ImmutableObjectBaseT) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |