DOFObjectdefine Method (DOFInterfaceID, DOFOperationControl, Int32)OpenDOF Object Access Library
Used by a Requestor to get the definition of an interface.

Namespace: org.opendof.core.oal
Assembly: dof-oal (in dof-oal.dll) Version: 7.0.1.2
Syntax

C#
public DOFInterface define(
	DOFInterfaceID interfaceID,
	DOFOperationControl control,
	int timeout
)

Parameters

interfaceID
Type: org.opendof.core.oalDOFInterfaceID
The interface identifier for the interface. This must not be null.
control
Type: org.opendof.core.oalDOFOperationControl
The control to use for the request.
timeout
Type: SystemInt32
How long to wait in milliseconds. Must be >= 0.

Return Value

Type: DOFInterface
The interface.
Exceptions

ExceptionCondition
DOFExceptionIf the interface cannot be retrieved within the timeout specified or other errors occur.
DOFException
Remarks

Used by a Requestor to get the definition of an interface. If the interface is not found locally and the timeout is > 0, an attempt will be made to retrieve the interface definition using the network within the timeout specified.

NOTE: The combination of using DOFObjectID.BROADCAST and dynamic interfaces (registry zero) is illegal.

See Also

Reference