OpenDOF Project
DOFResult DOFObject_Invoke ( DOFObject  obj,
const DOFInterfaceMethod  method,
uint16  parameterCount,
const DOFValue  parameters[],
DOFOperationControl  config,
uint32  timeout,
DOFException pException 
)

Invoke a Method.

The specified timeout is a maximum duration for the operation, and the operation fails if the timeout is reached before a response is received. Otherwise, the first response received is returned. Broadcast operations will be cancelled immediately after the first response, and therefore may not reach or be processed by all available providers.

Note
Beware that a timeout of DOF_TIMEOUT_NEVER may NEVER return if a response is not received!
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 time we wait for results, in milliseconds. The timeout begins after the operation has been processed and sent to appropriate connections.
[out]pExceptionAn Exception. If pException is NULL, no exception is reported. Otherwise, the output is either a DOFException, or NULL to indicate no exception occurred. DOFException_Destroy must be called to destroy the returned DOFException, if any.
Returns
The result of the Invoke operation, indicating success and containing the returned method values.
Exceptions
NULLis returned and pException is filled (if not null) with an appropriate exception in the following conditions:
  • The provider returned an exception
  • An invalid parameter was detected (including incompatible parameters or parameterCount passed for the method)
  • Insufficient resources available to perform the operation
core-c-dof-oal Version 8.0.1 Build 0
2018-01-22