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

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

Синтаксис

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
Целевая платформа Windows
Header winbase.h (включая Windows.h)
Библиотека Kernel32.lib
DLL Kernel32.dll

См. также

COMMCONFIG

Функции связи

Информационные ресурсы

SetDefaultCommConfig