OpenDOF Project
boolean DOFObject_Signal ( DOFObject  obj,
const DOFInterfaceEvent  evt,
uint16  parameterCount,
const DOFValue  parameters[] 
)

Signal that an Event occurred.

The signal is sent to all Requestors in compatible domains that have registered an Event handler for the Event, on the given Object.

Parameters
objThe DOFObject on which the Event occurred. This should not be NULL.
evtThe DOFInterfaceEvent that occurred. This should not be NULL.
parameterCountThe count of DOFValue elements in parameters.
parametersThe Event parameters, a list of DOFValue elements. This may be NULL if there are no parameters for the Event. Otherwise, the values should match the parameters defined by the Event.
Note
Though we are not notified, no event signal will be sent if
  • evt is NULL, or
  • parameters is NULL, or
  • evt not a DOFInterfaceEvent, or
  • A value type within parameters is not compatible with a type within evt's input parameter type list.
  • DOFResult could not be created, or
  • evt not registered for obj.
Returns
TRUE for success.
Exceptions
FALSEis returned if
  • obj is NULL or if its DOFObjectID is NULL, or
  • evt is NULL or is not an DOFInterfaceEvent, or
  • parameters is NULL or its parameter list is not compatible with the parameters of evt, or
  • memory allocation failed.
core-c-dof-oal Version 8.0.1 Build 0
2018-01-22