Функция GetDefaultCommConfigA (winbase.h)

Статья
11/20/2024

Извлекает конфигурацию по умолчанию для указанного устройства связи.

Синтаксис

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

Параметры

[in] lpszName

Имя устройства. Например, COM1-COM9 являются последовательными портами и LPT1-LPT9 являются параллельными портами.

[out] lpCC

Указатель на буфер, который получает структуру COMMCONFIG.

[in, out] lpdwSize

Указатель на переменную, указывающую размер буфера, на который указывает lpCC, в байтах. При возвращении переменная содержит количество байтов, скопированных в случае успешного выполнения функции, или количество байтов, необходимых, если буфер был слишком мал.

Возвращаемое значение

Если функция выполнена успешно, возвращаемое значение ненулевое.

Если функция завершается ошибкой, возвращаемое значение равно нулю. Чтобы получить расширенные сведения об ошибке, используйте функцию GetLastError.

Замечания

Заметка

Заголовок winbase.h определяет GetDefaultCommConfig как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows XP
минимальный поддерживаемый сервер	Windows Server 2003
целевая платформа	Виндоус
заголовка	winbase.h (включая Windows.h)
библиотеки	Kernel32.lib
DLL	Kernel32.dll

См. также

COMMCONFIG

функций связи

ресурсы связи

SetDefaultCommConfig

Поделиться через