Функция WSAGetQOSByName (winsock2.h)

Статья
08/27/2023

Функция WSAGetQOSByName инициализирует структуру QOS на основе именованного шаблона или предоставляет буфер для получения перечисления доступных имен шаблонов.

Синтаксис

BOOL WSAAPI WSAGetQOSByName(
  [in]      SOCKET   s,
  [in, out] LPWSABUF lpQOSName,
  [out]     LPQOS    lpQOS
);

Параметры

[in] s

Дескриптор, определяющий сокет.

[in, out] lpQOSName

Указатель на определенный шаблон качества службы.

[out] lpQOS

Указатель на заполняемую структуру QOS .

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

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

Код ошибки	Значение
WSANOTINITIALISED	Перед использованием этой функции должен произойти успешный вызов WSAStartup .
WSAENETDOWN	Произошел сбой сетевой подсистемы.
WSAENOTSOCK	Дескриптор не является сокетом.
WSAEFAULT	Параметр lpQOSName или lpQOS не является допустимой частью адресного пространства пользователя или длина буфера для lpQOS слишком мала.

Функция WSAGetQOSByName используется приложениями для инициализации структуры QOS набором известных значений, подходящих для определенного класса службы или типа мультимедиа. Эти значения хранятся в шаблоне, на который ссылается хорошо известное имя. Клиент может получить эти значения, задав параметр buf структуры WSABUF , указанной lpQOSName, которая указывает на строку ненулевой длины, указывающую имя шаблона. В этом случае используется только lpQOSName , а результаты возвращаются через lpQOS.

Кроме того, клиент может использовать эту функцию для получения перечисления доступных имен шаблонов. Клиент может сделать это, задав для параметра bufWSABUF , указанного lpQOSName , строку нулевой длины, завершаемую нулевым значением. В этом случае буфер, указанный buf , перезаписывается последовательностью из множества доступных имен шаблонов, завершаемых null, вплоть до количества байтов, доступных в buf , как указано параметром lenWSABUF , указанным lpQOSName. Сам список имен завершается именем нулевой длины. Если функция WSAGetQOSByName используется для получения имен шаблонов, параметр lpQOS игнорируется.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	winsock2.h
Библиотека	Ws2_32.lib
DLL	Ws2_32.dll