CommConfigDialogA function (winbase.h)
Displays a driver-supplied configuration dialog box.
Syntax
BOOL CommConfigDialogA(
[in] LPCSTR lpszName,
[in] HWND hWnd,
[in, out] LPCOMMCONFIG lpCC
);
Parameters
[in] lpszName
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.
[in] hWnd
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.
[in, out] lpCC
A pointer to a COMMCONFIG structure. This structure contains initial settings for the dialog box before the call, and changed values after the call.
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.
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 that 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 is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP |
| Minimum supported server | Windows Server 2003 |
| Target Platform | Windows |
| Header | winbase.h (include Windows.h) |
| Library | Kernel32.lib |
| DLL | Kernel32.dll |