Salvage Document

This functionality salvages a document that has 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 NGISSalvageDoc (LPTSTR cabinetName, LPISINDEX isIndex)

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
isIndex	A pointer to a variable of type ISINDEX . The structure ISINDEX contains information (viz.namely , index Index of the volumeVolume in which document is added and the index Index of the document in that volumeVolume) about the document to be salvaged.		Input Parameter

Output Parameters

This method returns an integer that will be 1 in case of success else an error code will be returned.

Usage in Java Application

Prototype

public int JPISSalvageDoc (String cabinetName, JPISIsIndex iSIndex)

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
isIndex	An object of type JPISIsIndex, which that contains information (viz.namely, index Index of the volumeVolume in which document is added and the index Index of the document in that volumeVolume) about the document to be salvaged.		Input Parameter

Output Parameters

This method returns an integer that will be 1 in case of success else an error code will be returned.

Prototype

public int JPISSalvageDoc_MT ( JtsConnection jsCon, String jtsAddress, short jtsPortId,

String cabinetName, JPISIsIndex isIndex

)

Input Parameters description

Name	Description	Valid Values	Type Of Parameter
jtsCon	This object holds a connection to the JTS. However, it can be sent as null, as a new socket connection to JTS using second two parameters (jtsAddress and portId) is created inside the function when the parameter is sent as null.	Object of class JtsConnection having a connection to JTS	Input Parameter
jtsAddress	IP aAddress on which the JTS server is running.	IP aAddress where JTS running	Input Parameter
portId	Port on which port JTS is running.	short>0	Input Parameter
cabinetName	Name of the Image Cabinet to which the User wants to connect.	Not Null	Input Parameter
isIndex	An object of type JPISIsIndex, which that contains information (viz.namely, index Index of the volumeVolume in which document is added and the index Index of the document in that volumeVolume) about the document to be salvaged.		Input Parameter

Output Parameters

This method returns an integer that will be 1 in case of success else an error code will be returned.