WireWare native: WireWare GetDatapointMinHookDelay I

From FactorityWiki

Jump to: navigation, search

Contents

Summary

Returns the shortest hook delay of the datapoint.


WIREWARE_RESULT WireWare_GetDatapointMinHookDelay_I (
WIREWARE_DATAPOINTI_HANDLE handle, // Handle of datapoint
int* length, // Pointer to memory location for minimum hook delay
WIREWARE_TIMEOUT timeout, // timeout in ms
);

Parameters

handle
Specifies the handle of the datapoint.
length
Points to a memory location, to which the minimum hook delay of the datapoint is copied.
timeout
Specifies the maximum allowed execution time (in ms) for this function.

Result

If the function succeeds, the return value is WIREWARE_ERROR_NONE. Otherwise it returns an appropriate error code.


Explanation

This function returns the minimum delay of all hooks which are registered for this datapoint object.
Note: This function is not implemented in this release and the constant 250 is returned.

See also

WireWare_CreateDatapoint_I, WireWare_GetDatapointLength_I, WireWare_GetDatapointType_I, WireWare_GetDatapointValue_I