Función de devolución de llamada LPWSPGETQOSBYNAME (ws2spi.h)

  • Artículo

La función WSPGetQOSByName inicializa una estructura de QOS basada en una plantilla con nombre o recupera una enumeración de los nombres de plantilla disponibles.

Sintaxis

LPWSPGETQOSBYNAME Lpwspgetqosbyname;

BOOL Lpwspgetqosbyname(
  [in]      SOCKET s,
  [in, out] LPWSABUF lpQOSName,
  [out]     LPQOS lpQOS,
  [out]     LPINT lpErrno
)
{...}

Parámetros

[in] s

Descriptor que identifica un socket.

[in, out] lpQOSName

Especifica el nombre de la plantilla de QOS o proporciona un búfer para recuperar una enumeración de los nombres de plantilla disponibles.

[out] lpQOS

Puntero a la estructura QOS que se va a rellenar.

[out] lpErrno

Puntero al código de error.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es TRUE. Si se produce un error en la función, el valor devuelto es FALSE y hay disponible un código de error específico en lpErrno.

Código de error Significado
WSAENETDOWN
 Error en el subsistema de red.
WSAENOTSOCK
 El descriptor no es un socket.
WSAENOTSOCK
 El argumento 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.
WSAEINVAL
 El nombre de plantilla de QOS especificado no es válido.

Comentarios

Los clientes pueden usar WSPGetQOSByName 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 miembro buf del WSABUF indicado por lpQOSName para que apunte a una cadena Unicode 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 LPWSPGetQOSByName para recuperar una enumeración de nombres de plantilla disponibles. El cliente puede hacerlo estableciendo el miembro buf del WSABUF indicado por lpQOSName en una cadena Unicode terminada en null de longitud cero. En este caso, el búfer indicado por buf se sobrescribe con una secuencia de tantas cadenas de nombre de plantilla Unicode terminadas en NULL como están disponibles hasta el número de bytes disponibles en buf , como indica el miembro len del WSABUF indicado por lpQOSName. La lista de nombres en sí finaliza mediante una cadena de nombre Unicode de longitud cero. Cuando LPWSPGetQOSByName se usa 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]
Encabezado ws2spi.h

Consulte también

LPWSPAccept

LPWSPConnect

LPWSPGetSockopt