DELETE_DOC command
| Command | Parameters |
|---|---|
| DELETE_DOC | /N doc number |
- Parameters
- N
- Specifies the zero-based relative document number within the document list of the active folder.
The number of documents in the list can be determined by using the
GET_NUM_DOCS_IN_LIST command. The values associated with a particular
document number can be retrieved by using the GET_DOC_VALUES command.
This parameter is required.
The doc number can be specified as -1 to indicate that all selected documents are to be deleted.
- Action
- Content Manager OnDemand deletes the specified document or all selected documents from the database. The deleted documents are removed from the Document List. Since the document numbers might have changed, information from a previous GET_DOC_VALUES command might no longer be valid.
- Return Code
-
- 0
ARS_DDE_RC_NO_ERROR- 2
ARS_DDE_RC_PARM_NOT_SPECIFIED- 3
ARS_DDE_RC_INVALID_PARM- 4
ARS_DDE_RC_SERVER_ERROR- 8
ARS_DDE_RC_FOLDER_NOT_OPEN- 11
ARS_DDE_RC_USER_ACTION_IN_PROGRESS- 12
ARS_DDE_RC_UNAUTHORIZED_OPERATION
- Return Data
- Content Manager OnDemand returns the number of documents that were successfully deleted. The returned null-terminated string can be converted to a long integer.
- Example:
Refer to the DoDdeCommand function.
DoDdeCommand( "DELETE_DOC", "23", NULL );