Name
prt_api_static_region_data
Purpose
Copy static region information into region structure.
Description
This function copies the static part of the region information into the region structure supplied by the application. Note that only region-configured capacity, status and quantity points are returned. If an invalid region is supplied, the region_id field is not populated.
Syntax
int prt_api_static_region_data (region_struct, region_id)
PRT_REGION_STRUCT region_list[list_size];
char *region_id;
Data Structures
typedef struct {
char region_id[PRT_REGION_ID_LEN + 1] - unique identifier
of tracking region.
COR_U4 region_status - region status.
COR_I4 total_items - total number of items in region
COR_I2 region_cap - number of item carriers in region
char stat_ptid[POINT_ID_LEN + 1] - status point identifier
char item_qty_ptid[POINT_ID_LEN + 1] - item quantity point id
COR_I2 total_item_counts - tells how many PRT_ITEM_COUNTS
elements are in the array pointed
to by type_totals.
PRT_ITEM_COUNTS *type_totals - pointer to array of
PRT_ITEM_COUNTS structures
(array must be deallocated by the user)
} PRT_REGION_STRUCT, *PRT_REGION_STRUCT_PTR;
Arguments
|
Argument |
Description |
|
Input |
|
|
region_struct |
Pointer to a buffer to receive tracking region data (required) |
|
region_id |
Character string identifying the region of interest. |
|
Output |
|
|
region_struct |
Populated tracking region data |
Return Value
If the region_id field in the region_struct buffer contains the supplied region_id, then the configured region quantity in the region_cap field, the status point in the stat_ptid field, and the item quantity point in the item_qty_ptid field are all populated with valid data; otherwise, the region could not be found, and the fields contain invalid data.
|
|
Application subroutines. |
