Function tip_RemoveDocument


Prototype: tip_RemoveDocument(Collection);
Arguments:

Collection: A Collection object. (CDM_Collection)
Id: The Id of the Document to be removed. (string)

C++ API Sections
Tcl API Sections
Description
Return Value
Notes
See Also
Index

Description:

This function will remove the Document object that has as Id the specified by the parameter "Id" value. If a Document with the requested Id does not exist, then an error will be prompted.

Return Value:

The return value from this function will be a standart Tcl completion code (of type int) with one of the values TCL_OK and TCL_ERROR. If the requested Document exists and is successfully removed, then TCL_OK will be returned. In case of an error, the return value will be TCL_ERROR and an error message describing the error will be left at the current Tcl interpreter (CDM_Interp).

Notes:

If the removed Document object has been previously opened (through tip_GetByExternalId, tip_GetDocument, tip_FirstDocument or tip_NextDocument) then the returned by these functions Document object will be invalidated.

This function is equivelant to CDM_RemoveDocument (C++ API).

See Also:

tip_GetByExternalId, tip_GetDocument, tip_FirstDocument, tip_NextDocument


Generated by: petasis@aias on Wed Aug 16 10:31:46 PM EEST 2006.