WSAGetQOSByName, fonction (winsock2.h)

Article
03/13/2024

La fonction WSAGetQOSByName initialise une structure QOS basée sur un modèle nommé, ou fournit une mémoire tampon pour récupérer une énumération des noms de modèles disponibles.

Syntaxe

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

Paramètres

[in] s

Descripteur identifiant un socket.

[in, out] lpQOSName

Pointeur vers un modèle de qualité de service spécifique.

[out] lpQOS

Pointeur vers la structure QOS à remplir.

Valeur retournée

Si WSAGetQOSByName réussit, la valeur de retour est TRUE. Si la fonction échoue, la valeur de retour est FALSE. Pour obtenir des informations d’erreur étendues, appelez WSAGetLastError.

Code d'erreur	Signification
WSANOTINITIALISED	Un appel WSAStartup réussi doit se produire avant d’utiliser cette fonction.
WSAENETDOWN	Le sous-système réseau a échoué.
WSAENOTSOCK	Le descripteur n’est pas un socket.
WSAEFAULT	Le paramètre lpQOSName ou lpQOS ne sont pas une partie valide de l’espace d’adressage utilisateur, ou la longueur de la mémoire tampon pour lpQOS est trop petite.

Remarques

La fonction WSAGetQOSByName est utilisée par les applications pour initialiser une structure QOS sur un ensemble de valeurs connues appropriées pour une classe de service ou un type de média particulier. Ces valeurs sont stockées dans un modèle référencé par un nom bien connu. Le client peut récupérer ces valeurs en définissant le paramètre buf de la structure WSABUF indiquée par lpQOSName, qui pointe vers une chaîne de longueur différente de zéro spécifiant un nom de modèle. Dans ce cas, l’utilisation de lpQOSName est IN uniquement et les résultats sont retournés via lpQOS.

Le client peut également utiliser cette fonction pour récupérer une énumération des noms de modèle disponibles. Pour ce faire, le client peut définir le paramètre buf du WSABUF indiqué par lpQOSName sur une chaîne terminée par null de longueur nulle. Dans ce cas, la mémoire tampon indiquée par buf est remplacée par une séquence d’autant de noms de modèle avec fin null disponibles que le nombre d’octets disponibles dans buf , tel qu’indiqué par le paramètre len du WSABUF indiqué par lpQOSName. La liste des noms elle-même est terminée par un nom de longueur nulle. Lorsque la fonction WSAGetQOSByName est utilisée pour récupérer des noms de modèle, le paramètre lpQOS est ignoré.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	winsock2.h
Bibliothèque	Ws2_32.lib
DLL	Ws2_32.dll