Export (0) Print
Expand All

COMMPROP structure

Contains information about a communications driver.

Syntax


typedef struct _COMMPROP {
  WORD  wPacketLength;
  WORD  wPacketVersion;
  DWORD dwServiceMask;
  DWORD dwReserved1;
  DWORD dwMaxTxQueue;
  DWORD dwMaxRxQueue;
  DWORD dwMaxBaud;
  DWORD dwProvSubType;
  DWORD dwProvCapabilities;
  DWORD dwSettableParams;
  DWORD dwSettableBaud;
  WORD  wSettableData;
  WORD  wSettableStopParity;
  DWORD dwCurrentTxQueue;
  DWORD dwCurrentRxQueue;
  DWORD dwProvSpec1;
  DWORD dwProvSpec2;
  WCHAR wcProvChar[1];
} COMMPROP, *LPCOMMPROP;

Members

wPacketLength

The size of the entire data packet, regardless of the amount of data requested, in bytes.

wPacketVersion

The version of the structure.

dwServiceMask

A bitmask indicating which services are implemented by this provider. The SP_SERIALCOMM value is always specified for communications providers, including modem providers.

dwReserved1

Reserved; do not use.

dwMaxTxQueue

The maximum size of the driver's internal output buffer, in bytes. A value of zero indicates that no maximum value is imposed by the serial provider.

dwMaxRxQueue

The maximum size of the driver's internal input buffer, in bytes. A value of zero indicates that no maximum value is imposed by the serial provider.

dwMaxBaud

The maximum allowable baud rate, in bits per second (bps). This member can be one of the following values.

ValueMeaning
BAUD_075
0x00000001

75 bps

BAUD_110
0x00000002

110 bps

BAUD_134_5
0x00000004

134.5 bps

BAUD_150
0x00000008

150 bps

BAUD_300
0x00000010

300 bps

BAUD_600
0x00000020

600 bps

BAUD_1200
0x00000040

1200 bps

BAUD_1800
0x00000080

1800 bps

BAUD_2400
0x00000100

2400 bps

BAUD_4800
0x00000200

4800 bps

BAUD_7200
0x00000400

7200 bps

BAUD_9600
0x00000800

9600 bps

BAUD_14400
0x00001000

14400 bps

BAUD_19200
0x00002000

19200 bps

BAUD_38400
0x00004000

38400 bps

BAUD_56K
0x00008000

56K bps

BAUD_57600
0x00040000

57600 bps

BAUD_115200
0x00020000

115200 bps

BAUD_128K
0x00010000

128K bps

BAUD_USER
0x10000000

Programmable baud rate.

 

dwProvSubType

The communications-provider type.

ValueMeaning
PST_FAX
0x00000021

FAX device

PST_LAT
0x00000101

LAT protocol

PST_MODEM
0x00000006

Modem device

PST_NETWORK_BRIDGE
0x00000100

Unspecified network bridge

PST_PARALLELPORT
0x00000002

Parallel port

PST_RS232
0x00000001

RS-232 serial port

PST_RS422
0x00000003

RS-422 port

PST_RS423
0x00000004

RS-423 port

PST_RS449
0x00000005

RS-449 port

PST_SCANNER
0x00000022

Scanner device

PST_TCPIP_TELNET
0x00000102

TCP/IP Telnet protocol

PST_UNSPECIFIED
0x00000000

Unspecified

PST_X25
0x00000103

X.25 standards

 

dwProvCapabilities

A bitmask indicating the capabilities offered by the provider. This member can be a combination of the following values.

ValueMeaning
PCF_16BITMODE
0x0200

Special 16-bit mode supported

PCF_DTRDSR
0x0001

DTR (data-terminal-ready)/DSR (data-set-ready) supported

PCF_INTTIMEOUTS
0x0080

Interval time-outs supported

PCF_PARITY_CHECK
0x0008

Parity checking supported

PCF_RLSD
0x0004

RLSD (receive-line-signal-detect) supported

PCF_RTSCTS
0x0002

RTS (request-to-send)/CTS (clear-to-send) supported

PCF_SETXCHAR
0x0020

Settable XON/XOFF supported

PCF_SPECIALCHARS
0x0100

Special character support provided

PCF_TOTALTIMEOUTS
0x0040

The total (elapsed) time-outs supported

PCF_XONXOFF
0x0010

XON/XOFF flow control supported

 

dwSettableParams

A bitmask indicating the communications parameters that can be changed. This member can be a combination of the following values.

ValueMeaning
SP_BAUD
0x0002

Baud rate

SP_DATABITS
0x0004

Data bits

SP_HANDSHAKING
0x0010

Handshaking (flow control)

SP_PARITY
0x0001

Parity

SP_PARITY_CHECK
0x0020

Parity checking

SP_RLSD
0x0040

RLSD (receive-line-signal-detect)

SP_STOPBITS
0x0008

Stop bits

 

dwSettableBaud

The baud rates that can be used. For values, see the dwMaxBaud member.

wSettableData

A bitmask indicating the number of data bits that can be set. This member can be a combination of the following values.

ValueMeaning
DATABITS_5
0x0001

5 data bits

DATABITS_6
0x0002

6 data bits

DATABITS_7
0x0004

7 data bits

DATABITS_8
0x0008

8 data bits

DATABITS_16
0x0010

16 data bits

DATABITS_16X
0x0020

Special wide path through serial hardware lines

 

wSettableStopParity

A bitmask indicating the stop bit and parity settings that can be selected. This member can be a combination of the following values.

ValueMeaning
STOPBITS_10
0x0001

1 stop bit

STOPBITS_15
0x0002

1.5 stop bits

STOPBITS_20
0x0004

2 stop bits

PARITY_NONE
0x0100

No parity

PARITY_ODD
0x0200

Odd parity

PARITY_EVEN
0x0400

Even parity

PARITY_MARK
0x0800

Mark parity

PARITY_SPACE
0x1000

Space parity

 

dwCurrentTxQueue

The size of the driver's internal output buffer, in bytes. A value of zero indicates that the value is unavailable.

dwCurrentRxQueue

The size of the driver's internal input buffer, in bytes. A value of zero indicates that the value is unavailable.

dwProvSpec1

Any provider-specific data. Applications should ignore this member unless they have detailed information about the format of the data required by the provider.

Set this member to COMMPROP_INITIALIZED before calling the GetCommProperties function to indicate that the wPacketLength member is already valid.

dwProvSpec2

Any provider-specific data. Applications should ignore this member unless they have detailed information about the format of the data required by the provider.

wcProvChar

Any provider-specific data. Applications should ignore this member unless they have detailed information about the format of the data required by the provider.

Remarks

The contents of the dwProvSpec1, dwProvSpec2, and wcProvChar members depend on the provider subtype (specified by the dwProvSubType member).

If the provider subtype is PST_MODEM, these members are used as follows.

ValueMeaning
dwProvSpec1Not used.
dwProvSpec2Not used.
wcProvCharContains a MODEMDEVCAPS structure.

 

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

Header

WinBase.h (include Windows.h)

See also

GetCommProperties

 

 

Community Additions

ADD
Show:
© 2014 Microsoft