Function CDM_RemoveDocument


Definition:#include <CDM.h>
Prototype:int CDM_RemoveDocument(CDM_Collection Collection, char *Id);
Arguments:

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

C/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 returned.

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 CDM_GetByExternalId, CDM_GetDocument, CDM_FirstDocument or CDM_NextDocument) then the returned by these functions Document object will be invalidated. The caller should not use such a pointer in any way.

This function is equivelant to tip_RemoveDocument (Tcl API).

See Also:

CDM_GetByExternalId, CDM_GetDocument, CDM_FirstDocument, CDM_NextDocument, tip_RemoveDocument


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