GetDefaultCommConfigA function (winbase.h)

Article
02/22/2024

Retrieves the default configuration for the specified communications device.

Syntax

BOOL GetDefaultCommConfigA(
  [in]      LPCSTR       lpszName,
  [out]     LPCOMMCONFIG lpCC,
  [in, out] LPDWORD      lpdwSize
);

Parameters

[in] lpszName

The name of the device. For example, COM1 through COM9 are serial ports and LPT1 through LPT9 are parallel ports.

[out] lpCC

A pointer to a buffer that receives a COMMCONFIG structure.

[in, out] lpdwSize

A pointer to a variable that specifies the size of the buffer pointed to by lpCC, in bytes. Upon return, the variable contains the number of bytes copied if the function succeeds, or the number of bytes required if the buffer was too small.

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, use the GetLastError function.

Remarks

Note

The winbase.h header defines GetDefaultCommConfig 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.

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