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.

dwProvSubType

The communications-provider type.

dwProvCapabilities

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

dwSettableParams

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

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.

wSettableStopParity

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

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.

Requirements

See also

GetCommProperties