IOCTL_SERIAL_WAIT_ON_MASK (Windows Embedded CE 6.0)
1/6/2010
This IOCTL instructs a serial driver to wait for a communications event that matches the event specified in the event mask. The DeviceIoControl function executes this IOCTL.
Parameters
- dwOpenData
[in] Handle returned from a call to the COM_Open function.
- dwCode
[in] Set to this IOCTL: IOCTL_SERIAL_WAIT_ON_MASK.
- pBufIn
Ignored.
- dwLenIn
Ignored.
- pBufOut
[out] Pointer to a DWORD variable to place the event mask. The returned mask shows the event that terminated the wait event. If a process attempts to change the device handle's event mask by using IOCTL_SERIAL_SET_WAIT_MASK, the driver should return immediately with an empty event mask.
- dwLenOut
[out] Greater than or equal to sizeof(DWORD).
- pdwActualOut
[out] Pointer to a DWORD variable to return the length of the returned data. If there is no error, pdwActualOut should be set to sizeof(DWORD).
Return Values
Returns TRUE if successful. Returns FALSE otherwise. To get extended error information, call GetLastError.
Remarks
The returned mask shows the event that terminated the wait. If a process attempts to change the device handle's event mask by using the IOCTL_SERIAL_SET_WAIT_MASK call, the driver should return immediately with (DWORD)0 as the returned event mask.
Requirements
Header | pegdser.h |
Windows Embedded CE | Windows CE 1.0 and later |
See Also
Reference
Serial Port Driver IOCTLs
COM_IOControl
COM_Open
DeviceIoControl
IOCTL_SERIAL_GET_WAIT_MASK
IOCTL_SERIAL_SET_WAIT_MASK