prt_api_req_groupitemlist
Name
prt_api_req_groupitemlist
Purpose
Request list of serialized item ID's in a tracking group.
Description
This routine provides a mechanism to request all Serialized Item IDs in a Tracking Group. If the request is a success the calling routine will receive back a count of the number of items in the list of Serialized Items in the Group. If the request fails, the calling routine will receive back status information on the reason for the failure.
Syntax
prt_api_req_groupitemlist (group_id, item_count, retstat)
char group_id[PRT_REGION_ID_LEN + 1];
COR_I4 *item_count;
COR_STATUS *retstat;Data Structures
None
Arguments
| Argument | Description |
|---|---|
| Input | |
| group_id | Unique identifier of tracking group (required) |
| Output | |
| *item_count | Count of Items returned to schema |
| *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
| PRTS_NO_GLOBAL_XREF | No XREF global section available (Warning) |
| PRTS_REGION_NOT_DEFINED | Region not configured (Warning) |
| PRTS_NO_GLOBAL_REGION | No global section available for Region (Warning) |
| PRTS_NO_ITEMS_AT_LOCATION | There are no items at location specified (Warning) |
| PRTI_GRP_ID_NULL | Group identifier NULL (Warning) |
| PRTI_GRP_ID_NDEF | Group identifier not valid (Warning) |
| PRTI_UNEXPECTED_SEG_TYPE | Unexpected segment type from PRT_DS (Warning) |
| PRTI_PARTNER_DEAD | Partner dead (Warning) |
| PRTI_EXTRA_SEGS | Ignored extra segments after STATUS_SEG or END_SEG (Warning) |
| PRTI_WRITE_PORT_ERR | Error in ipc_write_port (Warn/Fail) |
| PRTI_MF_INIT_ERR | Error initializing segment (Failure) |
| PRTI_CRESEG_ERR | Error creating segment (Failure) |
| PRTI_BAD_MSG | Error in segment (Failure) |
| PRTI_READ_PORT_ERR | Error in ipc_read_port (Failure) |