SnapDB Library
Archive
Settings for ArchiveInitializerTKey, TValue.
Definition
Namespace: SnapDB.Snap.Services.Writer
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 ArchiveInitializerSettings : SettingsBase<ArchiveInitializerSettings>VB
Public Class ArchiveInitializerSettings
Inherits SettingsBase(Of ArchiveInitializerSettings)C++
public ref class ArchiveInitializerSettings : public SettingsBase<ArchiveInitializerSettings^>JavaScript
SnapDB.Snap.Services.Writer.ArchiveInitializerSettings = function();
Type.createClass(
'SnapDB.Snap.Services.Writer.ArchiveInitializerSettings',
SnapDB.Snap.Services.SettingsBase`1);- Inheritance
- Object ImmutableObjectBaseArchiveInitializerSettings ImmutableObjectAutoBaseArchiveInitializerSettings SettingsBaseArchiveInitializerSettings ArchiveInitializerSettings
Constructors
| ArchiveInitializerSettings | Creates a new ArchiveInitializerSettings. |
Properties
| DesiredRemainingSpace | The desired number of bytes to leave on the disk after a rollover has completed. Otherwise, pick a different directory or throw an out of disk space exception. |
| DirectoryMethod | Gets the method that the directory structure will follow when writing a new file. |
| EncodingMethod | The encoding method that will be used to write files. |
| FileExtension | The extension to name the file. |
| Flags | The flags that will be added to any created archive files. |
| IsMemoryArchive | Gets if the archive file is a memory archive or a file archive. |
| 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) |
| Prefix | Gets or sets the file prefix. Can be String.Empty for no prefix. |
| WritePath | The list of all available paths to write files to. |
Methods
| Clone |
Creates a clone of the object, either as a read-only instance or an editable one.
(Inherited from ImmutableObjectBaseT) |
| CloneEditable |
Creates a clone of this class that is editable.
A clone is always created, even if this class is already editable.
(Inherited from ImmutableObjectBaseT) |
| CloneMembersAsEditable |
Request that member fields be cloned and marked as editable.
(Inherited from ImmutableObjectAutoBaseT) |
| CloneReadonly |
Creates a read-only clone of the object.
(Inherited from ImmutableObjectBaseT) |
| ConfigureInMemory | Creates a ArchiveInitializerTKey, TValue that will reside in memory. |
| ConfigureOnDisk | Creates a ArchiveInitializerTKey, TValue that will reside on the disk. |
| 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) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Load |
Loads the configuration of an archive stream from the specified stream.
(Overrides SettingsBaseTLoad(Stream)) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| Save |
Saves the configuration of an archive stream to the specified stream.
(Overrides SettingsBaseTSave(Stream)) |
| SetMembersAsReadOnly |
Requests that member fields be set to "read-only".
(Inherited from ImmutableObjectAutoBaseT) |
| 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) |
| Validate |
Validates the configuration of the archive stream.
(Overrides SettingsBaseTValidate) |