beautypg.com

B&B Electronics VFG3000 - Manual User Manual

Page 265

background image

F

UNCTION

R

EFERENCE

G

ET

A

LARM

T

AG

(

INDEX

)

R

EVISION

1

P

AGE

249

G

ET

A

LARM

T

AG

(

INDEX

)

A

RGUMENT

T

YPE

D

ESCRIPTION

index

int

Tag index number

D

ESCRIPTION

This function returns a bit mask integer representing the tag alarms state for the tag identified
with

index

. Bit 0 (ie. the bit with a value of 0x01) represents the Alarm 1 state and bit 1 (ie.

the bit with a value of 0x02) the Alarm 2.

Note: The tag index can be found from the tag name using the

FindTagIndex()

function

F

UNCTION

T

YPE

This function is passive.

R

ETURN

T

YPE

int.

E

XAMPLE

AlarmsInTag = GetAlarmTag(12)

In this example, the function returns the states of Alarm 1 and 2 for the tag with index 12.