GetRdcmArr
Returns an array containing the RECEIVED_DCM_IDs of all the API RDCM records. This function is useful because it provides you with the internal keys you need to query RDCM and to look at the full record for one or more RDCMs.
Syntax
short int GetRdcmArr(RdcmArr*rdcm_arr);
Parameters
rdcm_arr (out): a structure of type RdcmArr containing an array of the RECEIVED_DCM_IDs of all API RDCM records and the number of elements in that array.
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.
In order to:
- to get the API RDCM records, see GetRdcm.
- to process an API RDCM record as a unit, see ProcessRdcm.
Error Messages
Table 7-21 Error Messages for GetRdcmArr
| 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. |
|
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