Rockwell Automation Allen-Bradley ControlLogix 1756-MVI - Page 87

Publication 1756-RM004B-EN-P - October 2000
CIP Messaging API 4-35
MVIcip_Sleep
Syntax:
int MVIcip_Sleep( MVIHANDLE apiHandle, WORD msdelay );
Parameters:
apihandle handle returned by previous call to MVIcip_Open
msdelay time in milliseconds to suspend taskdelay
);
Description:
MVIcip_Sleep suspends the calling thread for at least msdelay
milliseconds. The actual delay may be several milliseconds longer than
msdelay, due to system overhead and the system timer granularity
(5ms).
Return Value:
MVI_SUCCESS success
MVI_ERR_NOACCESS
apihandle does not have access
Example:
MVIHANDLE apihandle;
int timeout=200;
// Simple timeout loop
while(timeout--)
{
// Poll for data, etc.
// Break if condition is met (no timeout)
// Else sleep a bit and try again
MVIcip_Sleep (apiHandle, 10);
}