OpenDOF Project
DOFOperation DOFObject_BeginDefine ( const DOFObject  self,
const DOFInterfaceID  interfaceID,
DOFOperationControl  config,
uint32  timeout,
const DOFObjectDefineCallback  callback,
void *  context 
)

Request that an Interface definition be located in the network and retrieved.

There is no guarantee that a definition can be found.

Resource Management:
This function allocates resources that must later be freed by calling DOFOperation_Destroy.
Parameters
selfThe Object on which to make the request. This must not be NULL.
interfaceIDThe identifier for the Interface to be defined. This should not be NULL, and should not be the wildcard IID.
configConfiguration options for the request operation (NULL for default configuration).
timeoutThe maximum amount of time to wait for the definition, 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 interface. The definition can be retrieved by calling DOFOperationDefine_WaitInterface.
contextApplication context data associated with the asynchronous operation.
Returns
A representation of the define operation.
Exceptions
NULLis returned if
  • an invalid parameter is detected; or
  • insufficient resources exist to create the operation.
core-c-dof-oal Version 7.1.5 Build 0
2017-01-25