prt_api_group_hold
Name
prt_api_group_hold
Purpose
Activate/deactivate hold specification for a tracking group.
Description
This routine provides a mechanism to activate or deactivate a HOLD specification for a Tracking Group. The calling routine receives back a status indicating the success or failure of the request.
Syntax
int prt_api_group_hold (group_id, ext_hold_reason,
act_hold_flag, comment, user_or_svc_id,
retstat)
char group_id[PRT_REGION_ID_LEN + 1];
char ext_hold_reason[SC_DESCRIPTION_LEN + 1];
COR_BOOLEAN act_hold_flag;
char comment[SC_DESCRIPTION_LEN + 1];
char user_or_svc_id[SERVICE_ID_LEN + 1];
COR_STATUS *retstat;
Data Structures
None
Arguments
Argument | Description |
---|---|
Input | |
group_id | Unique identifier of tracking group (required) |
ext_hold_reason | Text describing the reason for placing holds on Tracking Regions in this Tracking Group (required for activate, does not apply to deactivate) |
act_hold_flag | If set to TRUE, the Hold Specification is activated. If set to FALSE, the Hold Specification is Deactivated. (required) |
Comment | Comment to be recorded in PRT history log file. (optional) |
user_or_svc_id | User or service identifier (optional) |
Output | |
*retstat | Pointer to COR_STATUS structure |
Return Value
Either COR_SUCCESS, COR_WARNING, or COR_FAILURE.
If the function returns COR_WARNING or COR_FAILURE, additional error information can be found in the COR_STATUS structure.
Error Codes
PRTC_NO_SUCH_GROUP | No such group configured (Warning) |
PRTI_GRP_ID_NULL | Group identifier NULL (Warning) |
PRTI_GRP_ID_NDEF | Group identifier not valid (Warning) |
PRTI_EXT_HOLD_NO_REASON | Group hold specified without reason (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
.