PTMAP_get_init_state

This subroutine gets the configured state for the point from the POINT configuration file. Points can be configured and set to either ENABLED or DISABLED. If the point is disabled, no data is collected for that point.

Syntax

int PTMAP_get_init_state (point_addr, init_state,

                          retstat)

PTMAP_ADDR      *point_addr;

COR_BOOLEAN     *init_state;

COR_STATUS      *retstat;

Input Arguments

point_addr

Point address (pointer to the point).

Output Arguments

init_state

Either TRUE (the point was configured to be enabled) or FALSE (the point was configured to be disabled).

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_PT_ADR_NULL

 

PTMAP_PT_ADR_NOTF

 

PTMAP_SEQ_NUM_MISMATCH

Return Value

The contents of retstat.status.

More information

Point Management API subroutines.