GetCommConfig

The GetCommConfig function retrieves the current configuration of a communications device.

BOOL GetCommConfig(
  HANDLE hCommDev,    // handle to communications service
  LPCOMMCONFIG lpCC,  // configuration information
  LPDWORD lpdwSize    // size of buffer
);

Parameters

hCommDev

[in] Handle to the open communications device.

lpCC

[out] Pointer to a buffer that receives a COMMCONFIG structure.

lpdwSize

[in/out] Pointer to a variable that specifies the size, in bytes, of the buffer pointed to by lpCC. When the function returns, the variable contains the number of bytes copied if the function succeeds, or the number of bytes required if the buffer was too small.

Return Values

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, use the GetLastError function.

Requirements

  Windows NT/2000: Requires Windows NT 4.0 or later.
  Windows 95/98: Requires Windows 95 or later.
  Header: Declared in Winbase.h; include Windows.h.
  Library: Use Kernel32.lib.

See Also

Communications Overview, Communication Functions, SetCommConfig, COMMCONFIG