Solid File System

Virtual file system enigne that can be embedded into your software.

SolFSStorage.GetFileCompression method

Filter:

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

SolFSStorage     See also    

Overview

Returns file compression mode.

Declaration

[Pascal]
    procedure GetFileCompression(const FileName: TSolFSString; var Compression : TSolFSCompression; var CompressionLevel : LongWord; var PagesPerCluster : LongWord);

[Plain C]
    long _stdcall StorageGetFileCompression(unsigned long Storage, const wchar_t* FileName, unsigned long & Compression, unsigned long & CompressionLevel, unsigned long & PagesPerCluster);

[C++ (DLL/Lib)]
    void GetFileCompression(unsigned short * FileName, SolFSCompression & Compression, unsigned long & CompressionLevel, unsigned long & PagesPerCluster);

[C++ (VCL)]
    void __fastcall GetFileCompression(const TSolFSString FileName, SolFSCompression & Compression, unsigned long & CompressionLevel, unsigned long & PagesPerCluster);

[C++ (.NET)]
    SolFSCompression GetFileCompression(String *fileName);
    unsigned long GetFileCompressionLevel(String *fileName);
    unsigned long GetFileCompressionPagesPerCluster(String *fileName);

[C#]
    SolFSCompression GetFileCompression(String fileName);
    uint GetFileCompressionLevel(String fileName);
    uint GetFileCompressionPagesPerCluster(String fileName);

[VB.NET]
    Public Function GetFileCompression(ByVal fileName As String) As SolFSCompression
    Public Function GetFileCompressionLevel(ByVal fileName As String) As UInt32
    Public Function GetFileCompressionPagesPerCluster(ByVal fileName As String) As UInt32

[Java]
    CompressionTypes getFileCompression(String fileName)

Parameters

  • FileName - the full file name in the SolFSStorage.
  • Compression - returns file compression mode.
  • CompressionLevel - returns file compression level. Level value of 0 means "default" value
  • PagesPerCluster - returns the number of pages compressed as a single entity.
  • [Plain C] Storage - handle to the storage returned by Create or Open function.

Return value

GetCompression returns compression mode (see values below).
[.NET]
GetCompressionLevel returns the value of PagesPerCluster.
GetCompressionPagesPerCluster returns the value of PagesPerCluster.

     [Plain C]  0 if the function succeeded or one of Error codes if the function failed.

Values of SolFSCompression

Description

Use GeFileCompression to determine compression mode, compression level and the number of pages compressed as single unit.

See also

SetFileCompression

Back to top