RETRIEVE_DOC command
Content Manager OnDemand retrieves the resource group and/or document data and copies or appends it to the specified files.
Command | Parameters |
---|---|
RETRIEVE_DOC | /N doc number /P doc
path /R resgrp path /C combined
path /A |
- 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.
- P
- Specifies the fully-qualified path of a file into which the document data is to be placed. This parameter is optional.
- R
- Specifies the fully-qualified path of a file into which the resource group data is to be placed. This parameter is optional.
- C
- Specifies the fully-qualified path of a file into which the combined resource group and data is to be placed. This parameter is optional.
- A
- Indicates that the data is to be appended to an existing file rather than replacing the file. This parameter is optional.
- Action
- Any combination of the parameters can be specified, except that N is required.
- Return Code
-
- 0
ARS_DDE_RC_NO_ERROR
- 2
ARS_DDE_RC_PARM_NOT_SPECIFIED
- 3
ARS_DDE_RC_INVALID_PARM_VALUE
- 4
ARS_DDE_RC_SERVER_ERROR
- 5
ARS_DDE_RC_FILE_ERROR
- 8
ARS_DDE_RC_FOLDER_NOT_OPEN
- 9
ARS_DDE_RC_NO_DOC
- 11
ARS_DDE_RC_USER_ACTION_IN_PROGRESS
- Return Data
- None
- Example
- Refer to the DoDdeCommand function.
char parms[200]; sprintf( parms, "/N %d /C %s", 26, "C:\\DATA\\COMBINED.FIL"); DoDdeCommand( "RETRIEVE_DOC", parms, NULL );