Spinnaker C
4.3.0.189
 
Functions

The functions in this section all provide access to information and objects retrieved from nodes. This includes node properties and callbacks. More...

Functions

SPINNAKERC_API spinCommandExecute (spinNodeHandle hNode)
 Executes the action associated to a command node. More...
 
SPINNAKERC_API spinCommandIsDone (spinNodeHandle hNode, bool8_t *pbValue)
 Retrieves whether or not the action of a command node has completed. More...
 

Detailed Description

The functions in this section all provide access to information and objects retrieved from nodes. This includes node properties and callbacks.

Function Documentation

◆ spinCommandExecute()

SPINNAKERC_API spinCommandExecute ( spinNodeHandle  hNode)

Executes the action associated to a command node.

See also
spinError
Parameters
hNodeThe command node to execute
Returns
spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error
Examples
Sequencer_C.c, Trigger_C.c, and Trigger_C_QuickSpin.c.

◆ spinCommandIsDone()

SPINNAKERC_API spinCommandIsDone ( spinNodeHandle  hNode,
bool8_t pbValue 
)

Retrieves whether or not the action of a command node has completed.

See also
spinError
Parameters
hNodeThe command node to check
pValueThe boolean pointer to return whether or not the command has completed
Returns
spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error