SolFSStorage constructor (opens the storage)

Navigation

Web site
Support
Table Of Contents

Send comments on this topic

SolFSStorage constructor (opens the storage)

Filter:

Pascal DLL C++ (DLL/Lib) C++ (VCL) C++ (.NET) C# VB.NET

SolFSStorage See also

Overview

Creates storage object and opens the storage.

Declaration

[Pascal]
constructor Create(FileName: WideString; PageSize: LongWord=512; CreateNew: Boolean=False; Logo: WideString=''; PathSeparator: WideChar='/'; UseTransactions: Boolean=False; UseAccessTime: Boolean=False; OpenReadOnly : boolean = false);

[DLL]
long _stdcall StorageCreate(const wchar_t* FileName, char Overwrite, unsigned long PageSize, wchar_t* Logo, unsigned long* Storage, wchar_t PathSeparator, char UseTransactions, char UseAccessTime);

[C++ (DLL/Lib)]
    SolFSStorage(unsigned short *fileName, bool useTransactions, bool useLastAccessTime, wchar_t pathSeparator)
    SolFSStorage(unsigned short *fileName, bool useTransactions, bool useLastAccessTime, wchar_t pathSeparator, bool openReadOnly)
    SolFSStorage(unsigned short *fileName, bool overwrite, int pageSize, bool useTransactions, bool useLastAccessTime, wchar_t pathSeparator, unsigned short * logo)

[C++ (VCL)]
TStorage(WideString FileName, unsigned PageSize, bool CreateNew, WideString Logo, bool UseTransactions=true, bool UseAccessTime=false, WideChar PathSeparator='/', bool OpenReadOnly = false);

[C++ (.NET)]
    SolFSStorage(String* fileName, bool useTransactions, bool useLastAccessTime, wchar_t pathSeparator)
    SolFSStorage(String* fileName, bool useTransactions, bool useLastAccessTime, wchar_t pathSeparator, bool openReadOnly)
    SolFSStorage(String* fileName, bool overwrite, int pageSize, bool useTransactions, bool useLastAccessTime, wchar_t pathSeparator, String* logo)

[C#]
    SolFSStorage(string fileName, bool useTransactions, bool useLastAccessTime, char pathSeparator)
    SolFSStorage(string fileName, bool useTransactions, bool useLastAccessTime, char pathSeparator, bool openReadOnly)
    SolFSStorage(string fileName, bool overwrite, int pageSize, bool useTransactions, bool useLastAccessTime, char pathSeparator, string logo)

[VB.NET]
    SolFSStorage(fileName As String, useTransactions As Boolean, useLastAccessTime As Boolean, pathSeparator As Char)
    SolFSStorage(fileName As String, useTransactions As Boolean, useLastAccessTime As Boolean, pathSeparator As Char, bool openReadOnly As Boolean)
    SolFSStorage(fileName As String, overwrite As Boolean, pageSize As Integer, useTransactions As Boolean, useLastAccessTime As Boolean, pathSeparator As Char, logo As String)

Parameters

FileName - specifies the name of the storage file on physical media.
PageSize - specifies default page size (when creating new storage).
CreateNew - set this parameter to True if new storage must be created and False if existing one will be used.
Logo - is written at the beginning of the storage and can be any string. Use of this parameter is optional.
PathSeparator - specifies the separator which will be used in further storage operations.
UseTransactions - set this parameter to True to enable transactions and journalling. Note, that transactions slow down file write operations significantly.
UseAccessTime - defines whether last access time is written to storage when the file/folder is accessed. Writing access time slows down the operations.
Overwrite - specifies whether the Storage parameter must be overwrited if it is already exists.
OpenReadOnly - specifies if the storage must be opened-in readonly mode. This is applicable only to storages that already exist (ie. not created with this call).
[DLL] Storage - returns handle to the created SolFSStorage.
[DLL] UserData - application-defined parameter which is passed back to callback function.

[DLL] Return values

0 if the function succeeded or one of Error codes if the function failed.

Description

Use this constructor to create storage object and create or open a storage on physical disk. If the delegates (event handlers) are not specified, the storage is opened/created on physical media. If the constructor is used that expects delegates/event handlers is used and some of delegates/event handlers are not specified, constructor will fail.

[DLL] Note: this method creates new storage. To open a storage use Open and OpenCB functions.

DRIVER EDITION
The opened storage file must not have NTFS encrypted or compressed attributes.