Compact a volume Block

This functionality will compact the specified Volume Block. It will remove all the documents that have been marked for deletion from the specified volume blockVolume Block.

Usage in Visual C++/Visual Basic Application

Usage in Java Application

Error

Usage in Visual C++/Visual Basic Application

Prototype

int WINAPI NGISCompactVolumeBlock ( LPTSTR CabinetName, short VolumeId,

short VolBlockId, short SiteId

)

Input Parameters description

sName	Description	Valid Values	Type Of Parameter
CabinetName	Name of the Image Cabinet to which the User wants to connect.	NOT NULL	Input parameter
VolumeId	Index of the volume Volume in which given volume blockVolume Block exists for which compaction operation is to be performed.	Short number >0	Input parameter
VolBlockId	Index of the volume BlockVolume Block for which cCompaction operation is to be performed.	Short number >0	Input parameter
SiteId	Index of the siteSite where specified volume Volume exists.	Short number >0	Input parameter

Output Parameters

This method return 1 if the call is successful, otherwise, it returns an error code.

Usage in Java Application

Prototype

public int JPISCompactVolumeBlock ( String cabinetName, short VolumeId, short VolBlockId, short SiteId )

Input Parameters description

Name	Description	Valid Values	Type Of Parameter
CabinetName	Name of the Image Cabinet to which the User wants to connect.	NOT NULL	Input parameter
VolumeId	Index of the volume Volume in which given volume blockVolume Block exists for which cCompaction operation is to be performed.	Short number >0	Input parameter
VolBlockId	Index of the volume BlockVolume Block for which cCompaction operation is to be performed.	Short number >0	Input parameter
SiteId	Index of the siteSite where the specified volume Volume exists.	Short number >0	Input parameter

Output Parameters

This method return 1 if the call is successful, otherwise, it returns an error code.