Name
prt_api_unload_groupitemlist
Purpose
Unload list of serialized item ID's in a tracking group.
Description
This routine provides a mechanism to unload the list of Serialized Items obtained through the prt_api_req_groupitemlist routine. If the request is a success the calling routine will receive back an array populated with the Serialized Item information. If the request fails, the calling routine will receive back status information on the reason for the failure.
Syntax
int prt_api_unload_groupitemlist (list_size, item_hold_list,
retstat)
COR_I4 list_size;
PRT_ITEM_HOLD_STRUCT item_hold_list[list_size];
COR_STATUS *retstat;
Data Structures
typedef struct {
char item_id[PRT_ITEM_ID_LEN + 1] - unique identifier of
the Item.
char group_id[PRT_REGION_ID_LEN + 1] - identifier of group
responsible for
placing a hold on this item
COR_BOOLEAN ext_hold_active - if TRUE, HOLD is activated
for Item.
} PRT_ITEM_HOLD_STRUCT, *PRT_ITEM_HOLD_STRUCT_PTR;
Arguments
Argument |
Description |
Input |
|
list_size |
Size allocated for item_hold_list array (required) |
item_hold_list |
Array of hold items (required) |
Output |
|
item_hold_list |
Populated array of hold items |
*retstat |
Pointer to COR_STATUS structure |
Return Value
Either COR_SUCCESS, COR_FAILURE or COR_WARNING.
If the function returns COR_FAILURE additional error information can be found in the COR_STATUS structure.
Error Codes
PRTI_TOO_MANY_REQ |
Total number in list less than number requested (Warning) |
Application subroutines. |