OpenDOF Project
DOFOperation DOFObject_BeginInvoke ( DOFObject  obj,
const DOFInterfaceMethod  method,
uint16  parameterCount,
const DOFValue  parameters[],
DOFOperationControl  config,
uint32  timeout,
const DOFObjectInvokeCallback  callback,
void *  context 
)

Start an asynchronous Method invocation.

The specified timeout is a maximum duration for the operation, and the operation fails if the timeout is reached before a response is received. The operation may complete sooner if a response is received, but multicast operations always wait for the full timeout. Responses and notification of operation completion are 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 make the invocation. This should not be NULL.
methodThe Method to invoke. This should not be NULL.
parameterCountThe count of DOFValue elements in parameters.
parametersThe list of input parameters to the Method. This may be NULL if there are no parameters for the Method. Otherwise, the values should match the input parameters defined by the Method.
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 responses and the completion notification will be received. This may be null to ignore notification of the received values. The values (result) can be retrieved by calling DOFOperationInvoke_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 paramaters or parameterCount passed for the method); or
  • insufficient resources exist to create the operation.
core-c-dof-oal Version 7.1.5 Build 0
2017-01-25