GetCommState function

Retrieves the current control settings for a specified communications device.

Syntax

BOOL GetCommState(
  HANDLE hFile,
  LPDCB  lpDCB
);

Parameters

hFile

A handle to the communications device. The CreateFile function returns this handle.

lpDCB

A pointer to a DCB structure that receives the control settings information.

Return value

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

   
Minimum supported client Windows XP [desktop apps | UWP apps]
Minimum supported server Windows Server 2003 [desktop apps | UWP apps]
Target Platform Windows
Header winbase.h (include Windows.h)
Library Kernel32.lib
DLL Kernel32.dll

See also

Communications Functions

Communications Resources

CreateFile

DCB

SetCommState