Skip to content

Latest commit

 

History

History
101 lines (72 loc) · 3.11 KB

nf-winbase-commconfigdialoga.md

File metadata and controls

101 lines (72 loc) · 3.11 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:winbase.CommConfigDialogA
CommConfigDialogA function (winbase.h)
Displays a driver-supplied configuration dialog box. (ANSI)
CommConfigDialogA
winbase/CommConfigDialogA
base\commconfigdialog.htm
base
6c7a3833-1d40-40c5-bfa7-14523bc73ab0
12/05/2018
CommConfigDialog, CommConfigDialog function, CommConfigDialogA, CommConfigDialogW, _win32_commconfigdialog, base.commconfigdialog, winbase/CommConfigDialog, winbase/CommConfigDialogA, winbase/CommConfigDialogW
winbase.h
Windows.h
Windows
Windows XP
Windows Server 2003
CommConfigDialogW (Unicode) and CommConfigDialogA (ANSI)
Kernel32.lib
Kernel32.dll
Windows
19H1
CommConfigDialogA
winbase/CommConfigDialogA
c++
APIRef
kbSyntax
DllExport
Kernel32.dll
CommConfigDialog
CommConfigDialogA
CommConfigDialogW

CommConfigDialogA function

-description

Displays a driver-supplied configuration dialog box.

-parameters

-param lpszName [in]

The name of the device for which a dialog box should be displayed. For example, COM1 through COM9 are serial ports and LPT1 through LPT9 are parallel ports.

-param hWnd [in]

A handle to the window that owns the dialog box. This parameter can be any valid window handle, or it should be NULL if the dialog box is to have no owner.

-param lpCC [in, out]

A pointer to a COMMCONFIG structure. This structure contains initial settings for the dialog box before the call, and changed values after the call.

-returns

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.

-remarks

The CommConfigDialog function requires a dynamic-link library (DLL) provided by the communications hardware vendor.

Note

The winbase.h header defines CommConfigDialog as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

-see-also

COMMCONFIG

Communications Functions

Communications Resources