SetPageStatus
This function sets the status of a received page and commits. SetPageStatus enables you to track a specific page within a DCI. This is particularly useful, for example, when a DCI has multiple repeats within the same group that are listed on separate pages of the Case Report Form (CRF). Recording the page number from the original paper form provides a useful tracking mechanism for the electronic version of the document.
Syntax
short int SetPageStatus(doublereceived_page_id,
char*page_status);
Parameters
received_page_id (in) The RECEIVED_PAGE_ID of the received page whose status is to be updated.
page_status (in) The new status of the specified received page.
Return Value
SUCCESS or FAILURE.
Comments
This function will first lock the RDCI record to which the specified page belongs. If it cannot, it will fail; otherwise it will validate the new status and update the received page with the new status.
Error Messages
Table 7-33 Error Messages for SetPageStatus
| Number | Severity | Message |
|---|---|---|
|
285000 |
ERR |
Function called out of sequence. |
|
285900 |
ERR |
No current OCL database connection open. Use ConnectOCL to connect to OCL database. |
|
289000 |
ERR |
Cannot set page status when RDCI is locked. |
|
289100 |
ERR |
Unable to find the RDCI to which page belongs: \0. |
|
289200 |
ERR |
Unable to lock the RDCI to which page belongs. |
|
289300 |
ERR |
'Unknown' page status can only be changed to 'Missing' or 'Present'. |
|
289400 |
ERR |
The page status cannot be manually changed to a system status. |
|
289500 |
ERR |
A system page status cannot be manually changed. |
|
297000 |
ERR |
Null or invalid input pointers provided. |
|
302500 |
ERR |
Invalid page status. |
|
304600 |
ERR |
Function does not exist. |
|
304700 |
ERR |
Privilege does not exist. |
|
304800 |
ERR |
User is not authorized to call this function. |
Related Functions
None.
Parent topic: Data Capture API Functions