Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
COMMPROP structure (winbase.h)
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.
| Value | Meaning |
|---|---|
|
75 bps |
|
110 bps |
|
134.5 bps |
|
150 bps |
|
300 bps |
|
600 bps |
|
1200 bps |
|
1800 bps |
|
2400 bps |
|
4800 bps |
|
7200 bps |
|
9600 bps |
|
14400 bps |
|
19200 bps |
|
38400 bps |
|
56K bps |
|
57600 bps |
|
115200 bps |
|
128K bps |
|
Programmable baud rate. |
dwProvSubType
The communications-provider type.
| Value | Meaning |
|---|---|
|
FAX device |
|
LAT protocol |
|
Modem device |
|
Unspecified network bridge |
|
Parallel port |
|
RS-232 serial port |
|
RS-422 port |
|
RS-423 port |
|
RS-449 port |
|
Scanner device |
|
TCP/IP Telnet protocol |
|
Unspecified |
|
X.25 standards |
dwProvCapabilities
A bitmask indicating the capabilities offered by the provider. This member can be a combination of the following values.
| Value | Meaning |
|---|---|
|
Special 16-bit mode supported |
|
DTR (data-terminal-ready)/DSR (data-set-ready) supported |
|
Interval time-outs supported |
|
Parity checking supported |
|
RLSD (receive-line-signal-detect) supported |
|
RTS (request-to-send)/CTS (clear-to-send) supported |
|
Settable XON/XOFF supported |
|
Special character support provided |
|
The total (elapsed) time-outs supported |
|
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.
| Value | Meaning |
|---|---|
|
Baud rate |
|
Data bits |
|
Handshaking (flow control) |
|
Parity |
|
Parity checking |
|
RLSD (receive-line-signal-detect) |
|
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.
| Value | Meaning |
|---|---|
|
5 data bits |
|
6 data bits |
|
7 data bits |
|
8 data bits |
|
16 data bits |
|
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.
| Value | Meaning |
|---|---|
|
1 stop bit |
|
1.5 stop bits |
|
2 stop bits |
|
No parity |
|
Odd parity |
|
Even parity |
|
Mark parity |
|
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[1]
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.
| Value | Meaning |
|---|---|
| dwProvSpec1 | Not used. |
| dwProvSpec2 | Not used. |
| wcProvChar | Contains a MODEMDEVCAPS structure. |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP |
| Minimum supported server | Windows Server 2003 |
| Header | winbase.h (include Windows.h) |
See also
Feedback
Was this page helpful?