GetCommConfig

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

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

Parameters

hCommDev

Handle to the open communications device.

lpCC

Pointer to the buffer that receives the COMMCONFIG structure.

lpdwSize

Pointer to a 32-bit 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.

QuickInfo

  Windows NT: Requires version 4.0 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in winbase.h.
  Import Library: Use kernel32.lib.

See Also

Communications Overview, Communication Functions, SetCommConfig, COMMCONFIG