Delete document

This functionality marks document(s) for deletion in SMS Server. There are two different methods – one for a marking a single document and other for a lList of documents.

Usage in Visual C++/Visual Basic Application

Usage in Java Application

Error

Usage in Visual C++/Visual Basic Application

Prototype

int WINAPI NGISDeleteDoc ( 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.Thetype ISINDEX.The structure ISINDEX containsISINDEX contains information ( information (viz. namely, indexIndex of the volumeVolume in which document is to be added and the indexIndex of the document in that volumeVolume ) about the document to be deleted.		Input Parameter

Output Parameters

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

Prototype

int WINAPI NGISDeleteDocumentList ( LPTSTR cabinetName, int noOfDocs, 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
noOfDocs	Number of documents to be marked for deletion.	int > 0	Input parameter
isIndex	A pointer to a lList of structures of type ISINDEX .The structure ISINDEX contains information (viz. indexnamely, Index of the volumeVolume in which document added and the indexIndex of the document in that volumeVolume) about the document to be deleted.		Input Parameter

Output Parameters

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

Prototype

int WINAPI NGISDeleteDoc_MT ( SOCKET * phSock, LPTSTR siteAddress, short portId,

LPTSTR cabinetName, LPISINDEX isIndex

)

Input Parameters description

Name	Description	Valid Values	Type Of Parameter
phSock	A pointer to a variable of type SOCKET , which encapsulates a handle to a socket object to the JTS .	A valid socket connection to JTS	Input Parameter
siteAddress	IP address Address on which JTS server Server is running.	IP address where JTS running	Input Parameter
portId	Port on which JTS Server is running.	short>0	Input Parameter
cabinetName	Name of the Image Cabinet to which which the User wants to connect.	Not Null	Input Parameter
isIndex	A pointer to a variable of type ISINDEX .The structure ISINDEX contains information ( information (viz. namely,index Index of the volumeVolume in which document added and the indexIndex of the document in that volume )Volume) about the document to be deleted .deleted.		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 JPISDeleteDoc( 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 Object of type JPISIsIndex, which contains information (viz. indexnamely, Index of the volumeVolume in which document present and the indexIndex of the document in that volumeVolume) about the document which is to be deleted		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 JPISDeleteDocumentList (String cabinetName, int noOfDocs, Vector isIndexList)

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
noOfDocs	Number of documents to be marked for deletion.	int > 0	Input parameter
isIndexList	Vector of objects Objects of type JPISIsIndex. An object of type JPISIsIndex contains information (viz. indexnamely, Index of the volumeVolume in which document document is present and the indexIndex of the document in that volumeVolume) about the document that is to be deleted.		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 JPISDeleteDoc_MT ( JtsConnection jtsCon,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 address Address on which JTS server Server is running.	IP address Address where JTS running	Input Parameter
jtsPortId	Port on which 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 oObject of type JPISIsIndex, which that contains information ( information (viz. indexnamely, Index of the volumeVolume in which document is to addedbe added and the indexIndex of the document in that volume )Volume) about the document whichdocument that is to be deleted.		Input Parameter

Output Parameters

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

---