Función WSAGetQOSByName (winsock2.h)

Artículo
08/27/2023

La función WSAGetQOSByName inicializa una estructura de QOS basada en una plantilla con nombre, o proporciona un búfer para recuperar una enumeración de los nombres de plantilla disponibles.

Sintaxis

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

Parámetros

[in] s

Descriptor que identifica un socket.

[in, out] lpQOSName

Puntero a una plantilla de servicio de calidad específica.

[out] lpQOS

Puntero a la estructura QOS que se va a rellenar.

Valor devuelto

Si WSAGetQOSByName se realiza correctamente, el valor devuelto es TRUE. Si se produce un error en la función, el valor devuelto es FALSE. Para obtener información de error extendida, llame a WSAGetLastError.

Código de error	Significado
WSANOTINITIALISED	Debe producirse una llamada de WSAStartup correcta antes de usar esta función.
WSAENETDOWN	Error en el subsistema de red.
WSAENOTSOCK	El descriptor no es un socket.
WSAEFAULT	El parámetro lpQOSName o lpQOS no es una parte válida del espacio de direcciones del usuario o la longitud del búfer para lpQOS es demasiado pequeña.

Comentarios

Las aplicaciones usan la función WSAGetQOSByName para inicializar una estructura QOS en un conjunto de valores conocidos adecuados para una clase de servicio o tipo de medio determinado. Estos valores se almacenan en una plantilla a la que hace referencia un nombre conocido. El cliente puede recuperar estos valores estableciendo el parámetro buf de la estructura WSABUF indicada por lpQOSName, que apunta a una cadena de longitud distinta de cero que especifica un nombre de plantilla. En este caso, el uso de lpQOSName solo es IN y los resultados se devuelven a través de lpQOS.

Como alternativa, el cliente puede usar esta función para recuperar una enumeración de nombres de plantilla disponibles. El cliente puede hacerlo estableciendo el parámetro buf del WSABUF indicado por lpQOSName en una cadena terminada en null de longitud cero. En este caso, el búfer indicado por buf se sobrescribe con una secuencia de tantas plantillas disponibles terminadas en null hasta el número de bytes disponibles en buf , como se indica en el parámetro len del WSABUF indicado por lpQOSName. La lista de nombres en sí termina con un nombre de longitud cero. Cuando se usa la función WSAGetQOSByName para recuperar nombres de plantilla, se omite el parámetro lpQOS .

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	winsock2.h
Library	Ws2_32.lib
Archivo DLL	Ws2_32.dll