prt_api_region_setpoints

Name

prt_api_region_setpoints

Purpose

Enable/disable tracking region setpoints.

Description

This routine provides a mechanism for enabling and disabling the Item transition setpoints configured in the PRT Tracking Route records. These points are set by PRT when an Item transitions into the configured destination region.

Syntax

int prt_api_region_setpoints ( region_id, enable_setpt_flag,

                               comment, user_or_svc_id, retstat )

char        region_id[PRT_REGION_ID_LEN + 1];

COR_BOOLEAN enable_setpt_flag;

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

 

region_id

Tracking Region identifier (required)

enable_setpt_flag

If TRUE, enable the region item transition setpoint. If FALSE, disable it. (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

PRTC_BAD_REG_SPEC

Bad region specified (Warning)

PRTI_REG_ID_NULL

Region identifier NULL (Warning)

PRTI_REG_ID_NDEF

Region identifier not valid (Warning)

PRTI_MF_INIT_ERR

Error initializing segment (Failure)

PRTI_CRESEG_ERR

Error creating segment (Failure)

Plus all error codes returnable by prt_api_send_cmd.

More information

Application subroutines.