Skip to content

Group CICommand

Modules > CICommand

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

Public Functions

Type Name
spinCommandExecute (spinNodeHandle hNode)
spinCommandIsDone (spinNodeHandle hNode, bool8_t * pbValue)

Public Functions Documentation

function spinCommandExecute

spinCommandExecute (
    spinNodeHandle hNode
) 

Executes the action associated to a command node

See also: spinError

Parameters:

  • hNode The command node to execute

Returns:

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error


function spinCommandIsDone

spinCommandIsDone (
    spinNodeHandle hNode,
    bool8_t * pbValue
) 

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

See also: spinError

Parameters:

  • hNode The command node to check
  • pValue The 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