prt_api_unload_itemlist

Name

prt_api_unload_itemlist

Purpose

Unload list of items.

Description

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

Syntax

int prt_api_unload_itemlist (list_size, item_list, retstat)
COR_I4           list_size;
PRT_ITEM_STRUCT  item_list[list_size];
COR_STATUS       *retstat;

Data Structures

typedef struct {
  cor_time_t - reg_entry_time
  cor_time_t - last_mod_time
  char region_id[PRT_REGION_ID_LEN + 1] - identifier of the region
  COR_I2 region_loc - specific location in the region
  char item_id[PRT_ITEM_ID_LEN + 1] - unique identifier of a
                                      Serialized Item.
  char reference_id[PRT_ITEM_ID_LEN + 1] - secondary identifier
                                            of a Serialized Item.
  char item_type_id[PRT_ITEM_TYPE_ID_LEN + 1] - item type identifier.
  char parent_item_id[PRT_ITEM_ID_LEN + 1] - pertains only to
                                             Non-serialized Items.
  COR_U4 item_status - item status.
  COR_BOOLEAN int_hold_active - if TRUE, item held due to
                                internal hold.
  char int_hold_reason[SC_DESCRIPTION_LEN + 1]  - Comment
                       specifying reason for internal hold.
  COR_BOOLEAN ext_hold_active - if TRUE, item held due to
                                external hold.
  char group_id[PRT_REGION_ID_LEN + 1] - identifier of the group
  COR_I1 num_atts_valid - Number of valid attributes in the list
  PRT_ITEM_ATT item_att_list[PRT_NUM_ATTRIBUTES] - Item Attributes
                             pertain to Serialized Items.
} PRT_ITEM_STRUCT, *PRT_ITEM_STRUCT_PTR

Arguments

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