PTMAP_get_sl

This subroutine gets the responses associated with a Shopping List. It should be called following one of the PTMAP_wait functions. PTMAP_get_sl must be called once to access each response on the shopping list. For example, after sending a Shopping List containing four "Snapshot" requests and waiting for the responses, the application should call PTMAP_get_sl four times to get the responses. If the application calls PTMAP_get_sl a fifth time, COR_WARNING is returned.

Syntax

int PTMAP_get_sl (sl_adr, req_adr, point_adr,

                  rsp_type, rsp_stat, rsp_ptr,

                  retstat)

PTMAP_ADDR  *sl_adr;

PTMAP_ADDR  *req_adr;

PTMAP_ADDR  *point_adr;

int         *rsp_type;

COR_STATUS  *rsp_stat;

PTM_RSP     **rsp_ptr;

COR_STATUS  *retstat;

Input Arguments

sl_adr

The Shopping List used to send the requests that are to be processed.

Output Arguments

req_adr

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

point_adr

A pointer to the point for the request

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.