GetCommProperties

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

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.

Requirements

Runs On Versions Defined in Include Link to
Windows CE OS 1.0 and later Winbase.h   Serdev.lib

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

COMMPROP, CreateFile, SetCommState, SetCommTimeouts, SetupComm

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.