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 を呼び出します。

エラーコード	意味
WSANOTINITIALIZED	この関数を使用する前に、 WSAStartup 呼び出しが正常に行われる必要があります。
WSAENETDOWN	ネットワークサブシステムが失敗しました。
WSAENOTSOCK	記述子はソケットではありません。
WSAEFAULT	lpQOSName パラメーターまたは lpQOS パラメーターがユーザー・アドレス・スペースの有効な部分ではないか、lpQOS のバッファー長が小さすぎます。

注釈

WSAGetQOSByName 関数は、特定のサービスクラスまたはメディアの種類に適した既知の値のセットに QOS 構造体を初期化するためにアプリケーションによって使用されます。これらの値は、既知の名前で参照されるテンプレートに格納されます。クライアントは、テンプレート名を指定する長さが 0 以外の文字列を指す lpQOSName で示される WSABUF 構造体の buf パラメーターを設定することで、これらの値を取得できます。この場合、 lpQOSName の使用は IN のみであり、結果は lpQOS を介して返されます。

または、クライアントはこの関数を使用して、使用可能なテンプレート名の列挙を取得することもできます。クライアントは、lpQOSName で示される WSABUF の buf パラメーターを長さ 0 の null で終わる文字列に設定することで、これを行うことができます。この場合、buf によって示されるバッファーは、lpQOSName で示される WSABUF の len パラメーターによって示される buf で使用可能なバイト数まで、使用可能な null で終わるテンプレート名のシーケンスで上書きされます。名前のリスト自体は、長さ 0 の名前で終わる。 WSAGetQOSByName 関数を使用してテンプレート名を取得する場合、lpQOS パラメーターは無視されます。

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	winsock2.h
Library	Ws2_32.lib
[DLL]	Ws2_32.dll