ntddser.h header
This header is used by parports. For more information, see:
ntddser.h contains the following programming interfaces:
IOCTLs
| IOCTL_INTERNAL_SERENUM_REMOVE_SELF The IOCTL_INTERNAL_SERENUM_REMOVE_SELF request invalidates the bus relations of the filter DO that are associated with a target PDO. (Physically, this request invalidates the bus relations of the RS-232 port to which the target device is attached.). |
| IOCTL_SERENUM_GET_PORT_NAME The IOCTL_SERENUM_GET_PORT_NAME request returns the value of the PortName (or Identifier) entry value for the RS-232 port -- see Registry Settings for a Plug and Play Serial Device. |
| IOCTL_SERENUM_PORT_DESC The IOCTL_SERENUM_PORT_DESC request returns a description of the RS-232 port associated with a filter DO. |
| IOCTL_SERIAL_APPLY_DEFAULT_CONFIGURATION The IOCTL_SERIAL_APPLY_DEFAULT_CONFIGURATION control code configures the serial port to use the default hardware settings for the serial controller device. |
| IOCTL_SERIAL_CLEAR_STATS The IOCTL_SERIAL_CLEAR_STATS request clears the performance statistics for a serial device. |
| IOCTL_SERIAL_CLR_DTR The IOCTL_SERIAL_CLR_DTR request clears the data terminal ready (DTR) control signal. |
| IOCTL_SERIAL_CLR_RTS The IOCTL_SERIAL_CLR_RTS request clears the request to send (RTS) control signal. |
| IOCTL_SERIAL_CONFIG_SIZE The IOCTL_SERIAL_CONFIG_SIZE request returns information about configuration size. |
| IOCTL_SERIAL_GET_BAUD_RATE The IOCTL_SERIAL_GET_BAUD_RATE request returns the baud rate at which the serial port is currently configured to transmit and receive data. |
| IOCTL_SERIAL_GET_CHARS The IOCTL_SERIAL_GET_CHARS request retrieves the special characters that the serial controller driver uses with handshake flow control. The special characters are described by a SERIAL_CHARS structure. |
| IOCTL_SERIAL_GET_COMMSTATUS The IOCTL_SERIAL_GET_COMMSTATUS request returns information about the communication status of a serial device. For more information about the status information that is retrieved by this request, see SERIAL_STATUS. |
| IOCTL_SERIAL_GET_DTRRTS The IOCTL_SERIAL_GET_DTRRTS request returns information about the data terminal ready (DTR) control signal and the request to send (RTS) control signal. |
| IOCTL_SERIAL_GET_HANDFLOW The IOCTL_SERIAL_GET_HANDFLOW request returns information about the configuration of the handshake flow control set for a serial device. |
| IOCTL_SERIAL_GET_LINE_CONTROL The IOCTL_SERIAL_GET_LINE_CONTROL request returns information about the line control set for a serial device. The line control parameters include the number of stop bits, the number of data bits, and the parity. |
| IOCTL_SERIAL_GET_MODEM_CONTROL The IOCTL_SERIAL_GET_MODEM_CONTROL request returns the value of the modem control register in the serial controller. |
| IOCTL_SERIAL_GET_MODEMSTATUS The IOCTL_SERIAL_GET_MODEMSTATUS request updates the modem status, and returns the value of the modem status register before the update. |
| IOCTL_SERIAL_GET_PROPERTIES The IOCTL_SERIAL_GET_PROPERTIES request returns information about the capabilities of a serial controller. The capabilities information is returned in a SERIAL_COMMPROP structure. |
| IOCTL_SERIAL_GET_STATS The IOCTL_SERIAL_GET_STATS request returns information about the performance of a serial controller. |
| IOCTL_SERIAL_GET_TIMEOUTS The IOCTL_SERIAL_GET_TIMEOUTS request returns the time-out values that the serial controller driver uses with read and write requests. |
| IOCTL_SERIAL_GET_WAIT_MASK The IOCTL_SERIAL_GET_WAIT_MASK request returns the event wait mask that is currently set for the serial controller. |
| IOCTL_SERIAL_IMMEDIATE_CHAR The IOCTL_SERIAL_IMMEDIATE_CHAR request causes a specified character to be transmitted as soon as possible. |
| IOCTL_SERIAL_INTERNAL_BASIC_SETTINGS The IOCTL_SERIAL_INTERNAL_BASIC_SETTINGS request sets a serial device to a basic operating mode. |
| IOCTL_SERIAL_INTERNAL_CANCEL_WAIT_WAKE The IOCTL_SERIAL_INTERNAL_CANCEL_WAIT_WAKE request disables the wait/wake operation of a serial device. |
| IOCTL_SERIAL_INTERNAL_DO_WAIT_WAKE The IOCTL_SERIAL_INTERNAL_DO_WAIT_WAKE request enables the wait/wake operation of a serial device. |
| IOCTL_SERIAL_INTERNAL_RESTORE_SETTINGS The IOCTL_SERIAL_INTERNAL_RESTORE_SETTINGS request restores the specified operating mode of a serial device. |
| IOCTL_SERIAL_LSRMST_INSERT The IOCTL_SERIAL_LSRMST_INSERT request enables or disables the insertion of information about line status and modem status in the receive data stream. |
| IOCTL_SERIAL_PURGE The IOCTL_SERIAL_PURGE request cancels the specified requests and deletes data from the specified buffers. |
| IOCTL_SERIAL_RESET_DEVICE The IOCTL_SERIAL_RESET_DEVICE request resets a serial device. |
| IOCTL_SERIAL_SET_BAUD_RATE The IOCTL_SERIAL_SET_BAUD_RATE request sets the baud rate on a serial controller device. The serial controller driver verifies the specified baud rate. |
| IOCTL_SERIAL_SET_BREAK_OFF The IOCTL_SERIAL_SET_BREAK_OFF request sets the line control break signal inactive. |
| IOCTL_SERIAL_SET_BREAK_ON The IOCTL_SERIAL_SET_BREAK_ON request sets the line control break signal active. |
| IOCTL_SERIAL_SET_CHARS The IOCTL_SERIAL_SET_CHARS request sets the special characters that the serial controller driver uses for handshake flow control. This driver verifies the specified special characters. |
| IOCTL_SERIAL_SET_DTR The IOCTL_SERIAL_SET_DTR request sets DTR (data terminal ready). |
| IOCTL_SERIAL_SET_FIFO_CONTROL The IOCTL_SERIAL_SET_FIFO_CONTROL request sets the FIFO control register (FCR). Serial does not verify the specified FIFO control information. |
| IOCTL_SERIAL_SET_HANDFLOW The IOCTL_SERIAL_SET_HANDFLOW request sets the configuration of handshake flow control. The serial controller driver verifies the specified handshake flow control information. |
| IOCTL_SERIAL_SET_LINE_CONTROL The IOCTL_SERIAL_SET_LINE_CONTROL request sets the line control register (LCR). The line control register controls the data size, the number of stop bits, and the parity. |
| IOCTL_SERIAL_SET_MODEM_CONTROL The IOCTL_SERIAL_SET_MODEM_CONTROL request sets the modem control register (MCR) in the UART. No parameter checking is done on the client-supplied register settings. |
| IOCTL_SERIAL_SET_QUEUE_SIZE The IOCTL_SERIAL_SET_QUEUE_SIZE request sets the size of the internal receive buffer. If the requested size is greater than the current receive buffer size, a new receive buffer is created. Otherwise, the receive buffer is not changed. |
| IOCTL_SERIAL_SET_RTS The IOCTL_SERIAL_SET_RTS request sets RTS (request to send). |
| IOCTL_SERIAL_SET_TIMEOUTS The IOCTL_SERIAL_SET_TIMEOUTS request sets the time-out values that the serial controller driver uses for read and write requests. |
| IOCTL_SERIAL_SET_WAIT_MASK The IOCTL_SERIAL_SET_WAIT_MASK request configures the serial controller driver to notify a client after the occurrence of any one of a specified set of wait events. |
| IOCTL_SERIAL_SET_XOFF The IOCTL_SERIAL_SET_XOFF request emulates the reception of an XOFF (transmit off) character. |
| IOCTL_SERIAL_SET_XON The IOCTL_SERIAL_SET_XON request emulates the reception of a XON (transmit on) character, which restarts reception of data. |
| IOCTL_SERIAL_WAIT_ON_MASK The IOCTL_SERIAL_WAIT_ON_MASK request is used to wait for the occurrence of any wait event specified by using an IOCTL_SERIAL_SET_WAIT_MASK request. |
| IOCTL_SERIAL_XOFF_COUNTER The IOCTL_SERIAL_XOFF_COUNTER request sets an XOFF counter. An XOFF counter request supports clients that use software to emulate hardware handshake flow control. |
Structures
| SERIAL_BAUD_RATE The SERIAL_BAUD_RATE structure specifies the baud rate at which a serial port is currently configured to transmit and receive data. |
| SERIAL_CHARS The SERIAL_CHARS structure specifies the special characters that the serial controller driver uses for handshake flow control. |
| SERIAL_COMMPROP The SERIAL_COMMPROP structure specifies the properties of a serial port. |
| SERIAL_HANDFLOW The SERIAL_HANDFLOW structure specifies the handshake and flow control settings for a serial port. |
| SERIAL_LINE_CONTROL The SERIAL_LINE_CONTROL structure describes the control settings for the serial line. |
| SERIAL_QUEUE_SIZE The SERIAL_QUEUE_SIZE structure is used to resize the input buffer that the serial controller driver uses for serial receive operations. |
| SERIAL_STATUS The SERIAL_STATUS structure contains status information about the serial port. |
| SERIAL_TIMEOUTS The SERIAL_TIMEOUTS structure specifies the time-out parameters for read and write operations by the serial port. |
| SERIALPERF_STATS The SERIALPERF_STATS structure contains performance statistics for a serial port. |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for