Serial Port Driver IOCTLs (Compact 2013)

3/26/2014

The following table shows the serial port driver IOCTLs.

Programming element

Description

IOCTL_SERIAL_CLR_DTR

This IOCTL sets the Data Terminal Ready (DTR) signal to low. It is used by the COM_IOControl function.

IOCTL_SERIAL_CLR_RTS

This IOCTL sets the Request to Send (RTS) signal to low. It is used by the COM_IOControl function.

IOCTL_SERIAL_GET_COMMSTATUS

This IOCTL clears pending communications errors and returns the current communication status.

IOCTL_SERIAL_GET_DCB

This IOCTL gets the device-control block from a specified communications device.

IOCTL_SERIAL_GET_MODEMSTATUS

This IOCTL gets the current modem control-register values.

IOCTL_SERIAL_GET_PROPERTIES

This IOCTL gets information about the communications properties for a device.

IOCTL_SERIAL_GET_TIMEOUTS

This IOCTL gets the time-out parameters for all read/write operations on a specified communications device.

IOCTL_SERIAL_GET_WAIT_MASK

This IOCTL retrieves the value of the wait mask.

IOCTL_SERIAL_IMMEDIATE_CHAR

This IOCTL transmits a specified character ahead of any pending data in the output buffer of a communications device.

IOCTL_SERIAL_PURGE

This IOCTL discards characters from the output or input buffer of a specified communications resource.

IOCTL_SERIAL_SET_BREAK_OFF

This IOCTL clears the break state.

IOCTL_SERIAL_SET_BREAK_ON

This IOCTL sets the break state.

IOCTL_SERIAL_SET_DCB

This IOCTL sets the device-control block on a specified communications device.

IOCTL_SERIAL_SET_DTR

This IOCTL sets the Data Terminal Ready (DTR) signal to high.

IOCTL_SERIAL_SET_QUEUE_SIZE

This IOCTL sets the input and output queue sizes of a communications device.

IOCTL_SERIAL_SET_RTS

This IOCTL sets the Request to Send (RTS) signal to high.

IOCTL_SERIAL_SET_TIMEOUTS

This IOCTL sets the time-out parameters for all read/write operations on a specified communications device.

IOCTL_SERIAL_SET_WAIT_MASK

This IOCTL sets the value of the wait mask.

IOCTL_SERIAL_SET_XOFF

This IOCTL causes transmission to act as if an XOFF character has been received.

IOCTL_SERIAL_SET_XON

This IOCTL causes transmission to act as if an XON character has been received.

IOCTL_SERIAL_WAIT_ON_MASK

This IOCTL instructs a serial driver to wait for a communications event that matches the event specified in the event mask.

See Also

Reference

Serial Port Driver Reference