GetCommProperties (Compact 2013)

  • Article

3/28/2014

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 CreateFile function.
  • 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 Value

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

Remarks

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

Requirements

Header

winbase.h

Library

Serdev.lib

See Also

Reference

Serial Communications Functions
COMMPROP
SetCommState
SetCommTimeouts
SetupComm

Other Resources

CreateFile