OpenDOF Project
DOFOperation DOFObject_BeginSet ( DOFObject  obj,
const DOFInterfaceProperty  property,
DOFValue  value,
DOFOperationControl  config,
uint32  timeout,
const DOFObjectSetCallback  callback,
void *  context 
)

Start an asynchronous set of a Property's value.

The specified timeout is a maximum duration for the operation, and the operation fails if the timeout is reached before an acknowledgement is received. The operation may complete sooner if acknowledgement is received, but multicast operations always wait for the full timeout. Notification of operation completion is received through the specified callback. As with any DOFOperation, this operation can be extended or cancelled.

Resource Management:
This function allocates resources that must later be freed by calling DOFOperation_Destroy.
Parameters
objThe object on which to set the Property's value. This should not be NULL.
propertyThe Property to set. This should not be NULL.
valueThe new value for the Property. The data type must match the property's data type. NULL is permitted for a nullable type.
configConfiguration options for the request operation (NULL for default configuration).
timeoutThe duration for the asynchronous operation, in milliseconds. The timeout begins after the operation has been processed and sent to appropriate connections.
callbackThe callback through which the completion notification will be received. This may be null to ignore notification of the set completion. The result can be retrieved by calling DOFOperationSet_WaitResult.
contextApplication context data associated with the asynchronous operation.
Returns
A representation of the operation, or NULL if
  • an invalid parameter is detected (including incompatible value passed for the property); or
  • insufficient resources exist to create the operation.
core-c-dof-oal Version 8.0.1 Build 0
2018-01-22