SolFSStorage.Compact method

Navigation

Web site
Support
Table Of Contents

Send comments on this topic

SolFSStorage.Compact method

Filter:

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

SolFSStorage See also

Overview

Compacts the file, in which the storage is located.

Declaration

[Pascal]
function Compact: Boolean;

[DLL]
long _stdcall StorageCompact(unsigned long Storage, char *Compacted);

[C++ (DLL/Lib)]
bool Compact();

[C++ (VCL)]
bool __fastcall Compact();

[C++ (.NET)]
bool Compact();

[C#]
public bool Compact();

[VB.NET]
Public Function Compact as Boolean

Parameters

[DLL] Storage - handle to the storage returned by Create or Open function.
[DLL] Compacted - returns 1 on success,
0 if storage is busy with another process.

Return value

True on success.
False if storage is busy with another process.

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

Description

Use Compact method to decrease size of the physical file, in which the storage is located. Compacting is done by reordering pages in the file and then truncating the file (and removing extra space).