PTMAP_get_sl_point

This subroutine gets the response to a request for a specific point on a Shopping List. The point and Shopping List are specified by the application. This function must be called once for each outstanding response. If no response is available for the specified request, this function returns COR_WARNING.

Syntax

int PTMAP_get_sl_point (sl_adr, point_adr, req_adr,

                        rsp_type, rsp_stat, rsp_ptr,

                        retstat)

PTMAP_ADDR  *sl_adr;

PTMAP_ADDR  *point_adr;

PTMAP_ADDR  *req_adr;

int         *rsp_type;

COR_STATUS  *rsp_stat;

PTM_RSP     **rsp_ptr;

COR_STATUS  *retstat;

Input Arguments

sl_adr

Pointer to the Shopping List.

point_adr

A pointer to the point for the request

Output Arguments

req_adr

Pointer to the request for which the response was generated..

rsp_type

The type of response (such as, PTM_ONCHANGE or PTM_SNAPSHOT).

rsp_stat

Status of the response: COR_SUCCESS, COR_WARNING, or COR_FAILURE.

rsp_ptr

Pointer to a response structure.

Retstat

Pointer to status structure. The following errors may be returned (see Appendix A for an explanation of this code):

 

PTMAP_ADR_PTR_NULL

 

PTMAP_SL_ADR_NULL

 

PTMAP_SL_ADR_NOTF

 

PTMAP_SEQ_NUM_MISMATCH

 

The following warnings may be returned:

 

PTMAP_NO_RSP_RCV

 

PTMAP_RCV_QUE_ERR

Return Value

The contents of retstat.status.

More information

Point Management API subroutines.