Name
prt_api_advance_model
Purpose
Advance Tracking Model
Description
This routine provides a mechanism for advancing the next Item Carrier to leave a Source Tracking Region to a Destination Tracking Region.
Note: This call moves all items
at the FIRST (EXIT) location in the source region to the LAST
(ENTRY) location in the destination region.
Syntax
int prt_api_advance_model ( src_reg_id, dest_reg_id, comment,
user_or_svc_id, retstat )
char src_reg_id[PRT_REGION_ID_LEN + 1];
char dest_reg_id[PRT_REGION_ID_LEN + 1];
char comment[SC_DESCRIPTION_LEN + 1];
char user_or_svc_id[SERVICE_ID_LEN + 1];
COR_STATUS *retstat;
Data Structures
See Static Information Requirements
Arguments
|
Argument |
Description |
|
Input |
|
|
src_reg_id |
Source region id; region the item is moving out of (required). |
|
dest_reg_id |
Destination region id; region the item is moving into (required). |
|
comment |
Comment to be recorded in PRT history log file (optional). |
|
user_or_svc_id |
User or service identifier. This is used for logging purposes and is optional. If this pointer is NULL, the host process id is used. (optional) |
|
Output |
|
|
*retstat |
Pointer to COR_STATUS structure |
Return Value
Either COR_SUCCESS or COR_FAILURE.
If the function returns COR_FAILURE additional error information can be found in the COR_STATUS structure.
Error Codes
All error codes returnable by prt_api_move_item.
|
|
Application subroutines. |
