GetCommState

The GetCommState function retrieves the current control settings for a specified communications device.

BOOL GetCommState(
  HANDLE hFile,  // handle to communications device
  LPDCB lpDCB    // device-control block
);

Parameters

hFile

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

lpDCB

[out] Pointer to a DCB structure that receives the control settings information.

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, call GetLastError.

Requirements

  Windows NT/2000: Requires Windows NT 3.1 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, CreateFile, DCB, SetCommState