Share via


GetCommState

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function fills in a device-control block (a DCB structure) with the current control settings for a specified communication device.

Syntax

BOOL GetCommState(
  HANDLE hFile,
  LPDCB lpDCB
);

Parameters

  • hFile
    [in] Handle to the communication device, returned by the CreateFile function.
  • lpDCB
    [out] Long pointer to the DCB structure in which the control settings data is returned.

Return Value

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

Requirements

Header winbase.h
Library Serdev.lib
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

Serial Communications Functions
DCB
SetCommState

Other Resources

CreateFile