Oc_waitforeos -78 – Rockwell Automation 1747-PCINT API Software for 1746 I/O User Manual

Page 132

Advertising
background image

6–78

Library of Routines

OC_WaitForEos

Publication 1747-6.5.3 June 1998

OC_WaitForEos

Blocks the calling thread until an end-of-scan (EOS) notification is received from
the scanner or

msTimeout

milliseconds have elapsed.

Syntax:

int

OC_WaitForEos(HANDLE handle, DWORD msTimeout)

Parameters:

Description:

If an EOS message has been received since the last OCMSG_EOS message was retrieved with the
OC_PollScanner function, OC_WaitForEos returns SUCCESS immediately.

You can use this function to synchronize a control application with the I/O scan. See the
OC_EnableEOSNotify function.

Return Value:

Considerations:

Supported in the Windows NT API library only.

Parameter:

Description:

handle

Must be a valid handle returned from OC_OpenScanner

msTimeout

Specifies the number of milliseconds to wait
Set to INFINITE to wait forever

Name:

Value:

Description:

SUCCESS

0

an EOS message was received

ERR_RESPONSE

10

msTimeout

milliseconds elapsed without an EOS

ERR_OCACCESS

2

handle

does not have access to scanner

Advertising
This manual is related to the following products: