Name
prt_api_modify_region
Purpose
Modify tracking region data.
Description
This routine provides a mechanism to modify Tracking Region Data; specifically, the region status.
Syntax
int prt_api_modify_region ( status_bitmask, region_id,
region_status, comment,
user_or_svc_id, retstat )
COR_U4 status_bitmask;
char region_id;[PRT_REGION_ID_LEN + 1]
COR_U4 region_status;
char comment[SC_DESCRIPTION_LEN + 1];
char user_or_svc_id[SERVICE_ID_LEN + 1];
COR_STATUS *retstat;
Data Structures
See Static Information Requirements
Arguments
|
Argument |
Description |
|
Input |
|
|
status_bitmask |
Indicates the bit positions in the region_status that are to be modified. (required) |
|
region_id |
Region identifier (required) |
|
region_status |
Tracking Region status code (e.g. IN-LOCKED, OUT-LOCKED, FULL, OUT-OF-SEQ). (optional) |
|
comment |
Comment to be recorded in PRT history log file (optional). |
|
user_or_svc_id |
User or service identifier. This is used for logging purposes and is optional. If this pointer is NULL, the host process id is used. (optional) |
|
Output |
|
|
*retstat |
Pointer to COR_STATUS structure |
Return Value
Either COR_SUCCESS or COR_FAILURE.
If the function returns COR_FAILURE additional error information can be found in the COR_STATUS structure.
Error Codes
|
PRTC_BAD_REG_SPEC |
Bad region specified (Warning) |
|
PRTI_REG_ID_NULL |
Region identifier NULL (Warning) |
|
PRTI_REG_ID_NDEF |
Region identifier not valid (Warning) |
|
PRTI_MF_INIT_ERR |
Error initializing segment (Failure) |
|
PRTI_CRESEG_ERR |
Error creating segment (Failure) |
Plus all error codes returnable by prt_api_send_cmd.
|
|
Application subroutines. |
