WSAGetQOSByName 函式 (winsock2.h)

發行項
03/13/2024

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。

錯誤碼	意義
WSANOTINITIALISED	使用此函式之前，必須先進行成功的 WSAStartup 呼叫。
WSAENETDOWN	網路子系統失敗。
WSAENOTSOCK	描述項不是套接字。
WSAEFAULT	lpQOSName 或 lpQOS 參數不是使用者位址空間的有效部分，或 lpQOS 的緩衝區長度太小。

備註

WSAGetQOSByName 函式是由應用程式用來將 QOS 結構初始化為一組適用於特定服務類別或媒體類型的已知值。這些值會儲存在由已知名稱參考的範本中。用戶端可以藉由設定 lpQOSName 所指示之 WSABUF 結構的 buf 參數，以指向指定範本名稱的非零長度字串來擷取這些值。在此情況下， lpQOSName 的使用方式只有 IN，而且結果會透過 lpQOS 傳回。

或者，用戶端可以使用此函式來擷取可用範本名稱的列舉。用戶端可以藉由將 lpQOSName 所指示之 WSABUF 的 buf 參數設定為零長度的 Null 終止字串來執行此動作。在此情況下，buf 所指示的緩衝區會以一連串可用的 Null 終止範本名稱覆寫，最多到 buf 中可用的位元組數目，如 lpQOSName 所表示之 WSABUF 的 len 參數所表示。名稱本身的清單會以零長度的名稱終止。當 WSAGetQOSByName 函式用來擷取範本名稱時，會忽略 lpQOS 參數。

規格需求

需求	值
最低支援的用戶端	Windows 2000 專業版 [僅限傳統型應用程式]
最低支援的伺服器	Windows 2000 Server [僅限傳統型應用程式]
目標平台	Windows
標頭	winsock2.h
程式庫	Ws2_32.lib
Dll	Ws2_32.dll