Name

prt_api_unload_grouplist

Purpose

Unload list of tracking groups.

Description

This routine provides a mechanism to unload the list of Tracking Groups obtained through the prt_api_req_grouplist routine. If the request is a success the calling routine will receive back an array populated with the Tracking Group Data. If the request fails, the calling routine will receive back status information on the reason for the failure.

Syntax

int prt_api_unload_grouplist (list_size, group_list, retstat)

COR_I4            list_size;

PRT_GROUP_STRUCT  group_list[list_size];

COR_STATUS        *retstat;

Data Structures

typedef struct {

  char group_id[PRT_REGION_ID_LEN + 1] - unique identifier of

                                         tracking group.

  COR_BOOLEAN ext_hold_active - TRUE indicates HOLD is active

                                for group.

  char ext_hold_reason[SC_DESCRIPTION_LEN + 1] - reason for

                                                 Item HOLDS.

} PRT_GROUP_STRUCT, * PRT_GROUP_STRUCT_PTR;

Arguments

Argument	Description
Input
list_size	Number of array elements allocated for region_list array (required)
region_list	Pointer to a buffer to receive tracking region data (required)
Output
group_list[list_size]	Populated list of groups
*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

PRTI_TOO_MANY_REQ

Total number in list less than number requested (Warning).

More information

Application subroutines.

---