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

Статья
08/27/2023

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

Синтаксис

BOOL SetupComm(
  [in] HANDLE hFile,
  [in] DWORD  dwInQueue,
  [in] DWORD  dwOutQueue
);

Параметры

[in] hFile

Дескриптор устройства связи. Функция CreateFile возвращает этот дескриптор.

[in] dwInQueue

Рекомендуемый размер внутреннего входного буфера устройства в байтах.

[in] dwOutQueue

Рекомендуемый размер внутреннего выходного буфера устройства в байтах.

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

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

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

После того как процесс использует функцию CreateFile , чтобы открыть дескриптор для устройства связи, но перед выполнением операций ввода-вывода на устройстве он может вызвать SetupComm , чтобы задать параметры связи для устройства. Если они не заданы, устройство использует параметры по умолчанию при первом вызове другой функции связи.

Параметры dwInQueue и dwOutQueue указывают рекомендуемые размеры для внутренних буферов, используемых драйвером для указанного устройства. Например, пакеты протокола YMODEM немного превышают 1024 байта. Таким образом, рекомендуемый размер буфера может составлять 1200 байт для обмена данными по протоколу YMODEM. Для обмена данными на основе Ethernet рекомендуемый размер буфера может составлять 1600 байт, что немного больше, чем один кадр Ethernet.

Драйвер устройства получает рекомендуемые размеры буферов, но может использовать любую схему буферизации ввода-вывода, если она обеспечивает разумную производительность и данные не теряются из-за переполнения (за исключением крайних обстоятельств). Например, функция может быть успешной, даже если драйвер не выделяет буфер, если какая-то другая часть системы предоставляет эквивалентные функциональные возможности.

Требования

Требование	Значение
Минимальная версия клиента	Windows XP [классические приложения \| Приложения UWP]
Минимальная версия сервера	Windows Server 2003 [классические приложения \| Приложения UWP]
Целевая платформа	Windows
Header	winbase.h (включая Windows.h)
Библиотека	Kernel32.lib
DLL	Kernel32.dll

См. также

Share via