CALL gm.get.sinfo (vid, state, $spawn, id[], act.val, status)

 

Function

Access the State records in the GEM Items database to obtain various information about a particular state associated with a state variable. This includes the name of a spawn routine to execute upon a transition into the state, a variable to change the value of and its new value, a collection event to activate, and an alarm to set.

Input Parameters
vid

The identification number of the state variable associated with the desired state.

state

 The ID number for the desired State record.

Output Parameter

$spawn

The name of a V+ routine to execute. If none, an empty string.

id[ ]

An array of identification numbers:

0

0 Action variable (0 if none)

1

1 Collection event (0 if none)

2

Alarm to set (0 if none)

act.val

The new value for the "action variable", if appropriate. (The value of the variable is not changed by this routine.)

status

Status indicator. Values interpreted as:

0

Success

1

Specified State record does not exist in the GEM Items database.

 2

Specified State record does exist, but the associated VID specified in the record does not match the vid input parameter.

< 0

Standard AIM database status return code

Details

File: GEMDBASE.SQU

Related Routines

gm.eps.get (task, prev.state, eps.state)
gm.get.state (state, vid, $state, status)