Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This function fills a buffer with communication properties data for a specified communication device.

Syntax 

BOOL GetCommProperties(
  HANDLE 
hFile,
  LPCOMMPROP 
lpCommProp
);

Parameters

hFile

[in] Handle to the communication device, returned by the CreateFilefunction.

lpCommProp

[out] Long pointer to a COMMPROPstructure in which the communication properties data is returned. This data can be used in subsequent calls to the SetCommState, SetCommTimeouts, or SetupCommfunction to configure the communication device.

Return Value

Nonzero indicates success. Zero indicates failure. To obtain extended error data, call the GetLastErrorfunction.

Remarks

GetCommPropertiesreturns data from a device driver about the configuration settings supported by the driver.

Requirements

Header winbase.h
Library Serdev.lib
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also