Compact a volume

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

 

Usage in Visual C++/Visual Basic Application

Usage in Java Application

Error

 

Usage in Visual C++/Visual Basic Application

Prototype

int WINAPI  NGISCompactVolume( LPTSTR CabinetName, short VolumeId, 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 for which Compaction operation has to be performed.

Short number >0

Input parameter

SiteId

Index of the Site where the specified 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 JPISCompactVolume (  String cabinetName, short VolumeId, 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 for which the to perform Compaction operation has to be performed.

Short number >0

Input parameter

SiteId

Index of the Site where the specified Volume exists.

Short number >0

Input parameter

 

Output Parameters

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