GetCommProperties

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

At a Glance

Header file:	Winbase.h
Windows CE versions:	1.0 and later

Syntax

BOOL GetCommProperties(HANDLE hFile, LPCOMMPROP lpCommProp);

Parameters

hFile

[in] Handle to the communication device. The CreateFile function returns this handle.

lpCommProp

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

Return Values

Nonzero indicates success. Zero indicates failure. To get extended error data, call GetLastError.

Remarks

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