FlushResponses
Flushes information from the API Responses buffer, then either preserves the lock on the API RDCI record or releases it, based on the value of the parameter preserve_lock.
Syntax
short int FlushResponses(DCIAPIFlag
discard_changes
,
DCIAPIFlag
preserve_lock
);
Parameters
discard_changes
(in) A flag indicating whether this function should discard any changes pending in the Responses buffer prior to starting its work to flush the buffer. If the value is FALSE the function returns an error if there are changes pending, leaving the buffer intact.
preserve_lock
(in) A flag indicating whether the lock on the API RDCI record should be preserved or released. If the value is:
TRUE
– the lock remains.FALSE
– the lock on the API RDCI record is released.
Return Value
SUCCESS
or FAILURE
.
Comments
This function does not affect the RDCIRDCM buffer. To flush the header file, see FlushRdciRdcm.
Error Messages
Table 7-12 Error Messages for FlushResponses
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. |
288300 |
ERR |
The API RDCI record is not locked. |
294200 |
ERR |
An error occurred while processing the Received DCI structure and updating the PATIENT_DM_TRACKING table. |
294300 |
ERR |
An error occurred while processing the Received DCM structure and updating the received DCI. |
297100 |
ERR |
Changes pending. |
304600 |
ERR |
Function does not exist. |
304700 |
ERR |
Privilege does not exist. |
306500 |
ERR |
Unable to release lock. |
Related Functions
Parent topic: Data Capture API Functions