Subscribes or un-subscribe to configuration component command events by using the specified call back function.

Command events occur when a configuration component (as defined by a section in the configuration) is used to perform some task. Examples of this are:

  • Send a SCPI command to a device.
  • Begin execution of a Calibration.
  • Begin execution of a Sequence.
  • Setting a path.
  • Reading or Writing a file.

Parameters:

callbackPtr

The function pointer to the call back function to be called when an error occurs.

The callback function must have the signature defined by errorCallbackFn.

subscribe

Set to true if subscribing to the event and false is un-subscribing to the event.

Prototype Signature:

void SubscribeToScpiCommandEvents(commandCallbackFn callbackPtr, bool subscribe);


It is the responsibility of the calling program to make sure that the callback pointer is valid when an error occurs, otherwise an exception will be thrown causing an error.

See also: commandCallbackFn