Platform SDK: Hardware |
Using the IOCTL_SERIAL_LSRMST_INSERT control code enables or disables the placement of line status and modem status values into the regular data stream that an application acquires through the ReadFile function.
When this line-status and modem-status data placement mode is enabled, status values are preceded in the data stream by an escape character. The user-definable escape character is set by the IOCTL_SERIAL_LSRMST_INSERT control code. Status values consist of 1 to 3 BYTEs. See the Remarks section following for status value details.
To perform this operation, call the DeviceIoControl function with the following parameters.
BOOL DeviceIoControl( (HANDLE) hDevice, // handle to device IOCTL_SERIAL_LSRMST_INSERT, // dwIoControlCode operation (LPVOID) lpInBuffer, // input buffer (DWORD) nInBufferSize, // size of input buffer NULL, // lpOutBuffer; must be NULL 0, // nOutBufferSize; must be zero (LPDWORD) lpBytesReturned, // number of bytes returned (LPOVERLAPPED) lpOverlapped // OVERLAPPED structure );
If the BYTE is a nonzero value, it is the desired line-status and modem-status value escape character. The operation will turn the LSRMST_INSERT line-status and modem-status data placement mode on.
If the BYTE is zero, the operation will turn the LSRMST_INSERT line-status and modem-status data placement mode off.
The escape character cannot be the XON or XOFF character.
If lpOverlapped is NULL (nonoverlapped I/O), lpBytesReturned is used internally and cannot be NULL.
If lpOverlapped is not NULL (overlapped I/O), lpBytesReturned can be NULL.
If hDevice was opened with the FILE_FLAG_OVERLAPPED flag, lpOverlapped must point to a valid OVERLAPPED structure. In this case, the operation is performed as an overlapped (asynchronous) operation. If the device was opened with the FILE_FLAG_OVERLAPPED flag and lpOverlapped is NULL, the function fails in unpredictable ways.
If hDevice was opened without specifying the FILE_FLAG_OVERLAPPED flag, lpOverlapped is ignored and DeviceIoControl does not return until the operation has been completed, or until an error occurs.
If the operation succeeds, DeviceIoControl returns a nonzero value.
If the operation fails, DeviceIoControl returns zero. To get extended error information, call GetLastError.
Note An application that uses this scheme must examine each character in the data stream to determine the presence of modem-status or line-status data.
The following values follow the designated escape character in the data stream if the LSRMST_INSERT mode has been turned on.
Value | Meaning |
---|---|
SERIAL_LSRMST_ESCAPE | Indicates the reception of the escape character itself into the data stream. |
SERIAL_LSRMST_LSR_DATA | Indicates that a line status change occurred, and data was available in the receive hardware buffer. Following this BYTE is a BYTE value of the line status register is the BYTE present in the receive hardware buffer when the line status change was processed. |
SERIAL_LSRMST_LSR_NODATA | Indicates that a line status change occurred, but no data was available in the receive hardware buffer. |
SERIAL_LSRMST_MST | Indicates that a modem status change occurred. Following this BYTE is a BYTE that is the value of the modem status register when the modem status change was processed. |
Windows NT/2000: Requires Windows NT 3.1 or later.
Windows 95/98: Unsupported.
Header: Declared in Winioctl.h.
Device Input and Output Overview, Device Input and Output Control Codes, DeviceIoControl, ReadFile