GetRdcm
Returns the contents of a specific API RDCM record. Typically, you call this function after calling FetchRdci for an existing document or ProcessRdci for a new document.
Syntax
short int GetRdcm(doublereceived_dcm_id,
RdcmRecord*rdcm_rec);
Parameters
received_dcm_id (in) The RECEIVED_DCM_ID of the API RDCM record to be returned.
rdcm_rec (out) contains the contents of the specified API RDCM record in a data structure of type RdcmRecord.
Return Value
SUCCESS or FAILURE.
Comments
This function fails if:
- the API RDCI buffer is empty.
- there are changes pending in the API RDCI buffer that have not yet been processed through a call to ProcessRdci.
- there is no API RDCM record whose RECEIVED_DCM_ID equals the parameter received_dcm_id.
In order to:
- populate an empty API RDCI buffer, see FetchRdci or CreateRdci.
- change the contents of a certain API RDCM record, see SetRdcm.
- process an API RDCM record as a unit, see ProcessRdcm.
Error Messages
Table 7-20 Error Messages for GetRdcm
| Number | Severity | Message |
|---|---|---|
|
284900 |
ERR |
User does not have the privilege to call function in the current mode. |
|
285000 |
ERR |
Function called out of sequence. |
|
285900 |
ERR |
No current OCL database connection open. Use ConnectOCL to connect to OCL database. |
|
286100 |
ERR |
RDCM with this |
|
286600 |
ERR |
Audit reason required and not provided. |
|
297000 |
ERR |
Null or invalid input pointers provided. |
|
304600 |
ERR |
Function does not exist. |
|
304700 |
ERR |
Privilege does not exist. |
|
306100 |
ERR |
Changes pending that have not been processed. |
Related Functions
Parent topic: Data Capture API Functions