WSAGetQOSByName-Funktion (winsock2.h)

Artikel
08/27/2023

Die WSAGetQOSByName-Funktion initialisiert eine QOS-Struktur basierend auf einer benannten Vorlage oder stellt einen Puffer bereit, um eine Enumeration der verfügbaren Vorlagennamen abzurufen.

Syntax

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

Parameter

[in] s

Ein Deskriptor, der einen Socket identifiziert.

[in, out] lpQOSName

Ein Zeiger auf eine bestimmte Dienstqualitätsvorlage.

[out] lpQOS

Ein Zeiger auf die zu füllende QOS-Struktur .

Rückgabewert

Wenn WSAGetQOSByName erfolgreich ist, ist der Rückgabewert TRUE. Wenn die Funktion fehlschlägt, ist der Rückgabewert FALSE. Rufen Sie WSAGetLastError auf, um erweiterte Fehlerinformationen zu erhalten.

Fehlercode	Bedeutung
WSANOTINITIALISIERT	Vor der Verwendung dieser Funktion muss ein erfolgreicher WSAStartup-Aufruf erfolgen.
WSAENETDOWN	Fehler beim Netzwerksubsystem.
WSAENOTSOCK	Der Deskriptor ist kein Socket.
WSAEFAULT	Der lpQOSName- oder lpQOS-Parameter ist kein gültiger Teil des Benutzeradressraums, oder die Pufferlänge für lpQOS ist zu klein.

Hinweise

Die WSAGetQOSByName-Funktion wird von Anwendungen verwendet, um eine QOS-Struktur mit einem Satz bekannter Werte zu initialisieren, die für eine bestimmte Dienstklasse oder einen bestimmten Medientyp geeignet sind. Diese Werte werden in einer Vorlage gespeichert, auf die mit einem bekannten Namen verwiesen wird. Der Client kann diese Werte abrufen, indem er den buf-Parameter der durch lpQOSName angegebenen WSABUF-Struktur festlegt, die auf eine Zeichenfolge ungleich null Länge verweist, die einen Vorlagennamen angibt. In diesem Fall ist die Verwendung von lpQOSName nur IN, und die Ergebnisse werden über lpQOS zurückgegeben.

Alternativ kann der Client diese Funktion verwenden, um eine Enumeration der verfügbaren Vorlagennamen abzurufen. Der Client kann dies tun, indem er den buf-Parameter des durch lpQOSName angegebenen WSABUF auf eine null-endende Zeichenfolge festlegt. In diesem Fall wird der durch buf angegebene Puffer mit einer Sequenz von so vielen verfügbaren, NULL-endenden Vorlagennamen bis zur Anzahl der in buf verfügbaren Bytes überschrieben, wie durch den len-Parameter des durch lpQOSName angegebenen WSABUF-Parameters angegeben. Die Liste der Namen selbst wird durch einen Namen der Länge Null beendet. Wenn die WSAGetQOSByName-Funktion zum Abrufen von Vorlagennamen verwendet wird, wird der lpQOS-Parameter ignoriert.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	winsock2.h
Bibliothek	Ws2_32.lib
DLL	Ws2_32.dll