AutoCompactAt Property

The free space percentage threshold a vault must reach to be eligible for automatic compaction.

Syntax

ANSI (Cross Platform)
int GetAutoCompactAt();
int SetAutoCompactAt(int iAutoCompactAt); Unicode (Windows) INT GetAutoCompactAt();
INT SetAutoCompactAt(INT iAutoCompactAt);
@property (nonatomic,readwrite,assign,getter=autoCompactAt,setter=setAutoCompactAt:) int autoCompactAt;
- (int)autoCompactAt;
- (void)setAutoCompactAt:(int)newAutoCompactAt;
#define PID_CBVAULT_AUTOCOMPACTAT 2

CBFSVAULT_EXTERNAL void* CBFSVAULT_CALL CBFSVault_CBVault_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
CBFSVAULT_EXTERNAL int CBFSVAULT_CALL CBFSVault_CBVault_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

25

Remarks

This property specifies the percentage of free space a vault must have, at minimum, in order for it to be eligible for automatic vault compaction. An eligible vault may be compacted automatically in the background at any time. Please refer to the CompactVault method for more information about the compacting process itself.

To help guard against excessive automatic compaction operations, applications can set the AutoCompactDelay configuration setting to a non-zero value. Alternatively, this property can be set to 0 to disable automatic compaction completely.

A vault opened in ReadOnly mode will never be compacted, regardless of this property's value.

Note: This property cannot be changed within events.

Data Type

Integer

Copyright (c) 2022 Callback Technologies, Inc. - All rights reserved.
CBFS Vault 2020 C++ Edition - Version 20.0 [Build 8347]