PTMAP_add_alarm_ack_state

This subroutine adds a request to receive point information when the point's alarm acknowledges state changes.

Point Management sends the information whenever the acknowledge state of the point changes. Use PTMAP_fold_ack_state to determine the new state of the point.

Syntax

int PTMAP_add_alam_ack_state ( sl_adr, point_adr,

                               req_adr, retstat )

PTMAP_ADDR      *sl_adr;

PTMAP_ADDR      *point_adr;

PTMAP_ADDR      *req_adr;

COR_STATUS          *retstat;

Input Arguments

sl_adr

A Shopping List ID created by a call to PTMAP_add_sl.

point_adr

A Point ID created by a call to PTMAP_add_point.

Output Arguments

req_adr

Identifier used to reference this request.

retstat

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

PTMAP_ADDR_PTR_NULL

PTMAP_SL_ADR_NULL

PTMAP_SL_ADDR_NOTF

PTMAP_SEQ_NUM_MISMATCH

PTMAP_INVAL_DATA_TYPE

PTMAP_INVAL_ELEMENTS

Return Value

The contents of retstat.status.

More information

Point Management API subroutines.