IOCTL_SERIAL_GET_COMMSTATUS
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This IOCTL clears pending communications errors and returns the current communication status. 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_GET_COMMSTATUS.
- pBufIn
Ignored.
- dwLenIn
Ignored.
- pBufOut
[out] Pointer to a SERIAL_DEV_STATUS structure to contain the returned status information.
- dwLenOut
[out] Greater than or equal to sizeof(SERIAL_DEV_STATUS).
- pdwActualOut
[out] Pointer to a DWORD variable to return the length of the returned data. Set to sizeof(SERIAL_DEV_STATUS) if there is no error.
Return Values
Returns TRUE if successful. Returns FALSE otherwise. To get extended error information, call GetLastError.
Requirements
| Header | pegdser.h |
| Windows Embedded CE | Windows CE 1.0 and later |