WlanHostedNetworkQueryProperty 函式 (wlanapi.h)

發行項
03/04/2024

WlanHostedNetworkQueryProperty 函式會查詢無線託管網路的目前靜態屬性。

語法

DWORD WlanHostedNetworkQueryProperty(
  [in]  HANDLE                     hClientHandle,
  [in]  WLAN_HOSTED_NETWORK_OPCODE OpCode,
  [out] PDWORD                     pdwDataSize,
  [out] PVOID                      *ppvData,
  [out] PWLAN_OPCODE_VALUE_TYPE    pWlanOpcodeValueType,
        PVOID                      pvReserved
);

參數

[in] hClientHandle

用戶端的會話句柄，由先前呼叫 WlanOpenHandle 函式所傳回。

[in] OpCode

要查詢之屬性的標識碼。此標識碼可以是 Wlanapi.h 頭文件中定義之WLAN_HOSTED_NETWORK_OPCODE列舉中的任何值。

[out] pdwDataSize

值指標，指定 ppvData 參數中傳回之緩衝區的大小，以位元組為單位，如果 WlanHostedNetworkQueryProperty 函式 的呼叫成功。

[out] ppvData

在輸入時，此參數必須是 NULL。

在輸出時，如果 WlanHostedNetworkQueryProperty 函式的呼叫成功，此參數會接收以靜態屬性所傳回之緩衝區的指標。與此緩衝區相關聯的數據類型取決於 OpCode 參數的值。

[out] pWlanOpcodeValueType

如果 WlanHostedNetworkQueryProperty 函式的呼叫成功，則為接收無線託管網路屬性之實值類型的值指標。傳回的值是 Wlanapi.h 頭檔中所定義之WLAN_OPCODE_VALUE_TYPE列舉型別。

pvReserved

保留供未來使用。此參數必須是 NULL。

傳回值

如果函式成功，傳回值會ERROR_SUCCESS。

如果函式失敗，傳回值可能是下列其中一個傳回碼。

傳回碼	Description
ERROR_BAD_CONFIGURATION	無線託管網路的組態數據未設定。如果應用程式呼叫 WlanHostedNetworkQueryProperty 函式，並將 OpCode 參數設定為 wlan_hosted_network_opcode_station_profile 或 wlan_hosted_network_opcode_connection_settings ，則會在無線託管網路中設定 SSID 之前傳回此錯誤。
ERROR_INVALID_HANDLE	句柄無效。如果在句柄數據表中找不到 hClientHandle 參數中指定的句柄，就會傳回此錯誤。
ERROR_INVALID_PARAMETER	參數不正確。如果發生下列任一情況，就會傳回此錯誤： hClientHandle 為 NULL。 OpCode 不是 WLAN_HOSTED_NETWORK_OPCODE中定義的其中一個列舉值。 pdwDataSize 為 NULL。 ppvData 為 NULL。 pWlanOpcodeValueType 為 NULL。 pvReserved 不是 NULL。
ERROR_INVALID_STATE	資源未處於執行要求作業的正確狀態。如果無線託管網路正在進行關機，就會發生這種情況。
ERROR_OUTOFMEMORY	儲存體不足，無法完成此作業。
ERROR_SERVICE_NOT_ACTIVE	尚未啟動服務。如果WLAN自動設定服務未執行，就會傳回此錯誤。
其他	各種 RPC 和其他錯誤碼。使用 FormatMessage 取得傳回錯誤的訊息字串。

備註

WlanHostedNetworkQueryProperty 函式是新增的原生無線 API 擴充功能，可支援 Windows 7 和已安裝無線 LAN 服務的 Windows Server 2008 R2 無線託管網路。

用戶端應用程式會呼叫 WlanHostedNetworkQueryProperty 函式，以查詢無線託管網路的目前靜態屬性。此函式不會變更無線託管網路的狀態或屬性。

如果函式成功， ppvData 參數會指向包含所要求屬性的緩衝區。這個緩衝區的大小會在 pwdDataSize 參數所傳回的指標中傳回。 WLAN_OPCODE_VALUE_TYPE會在 pWlanOpcodeValueType 參數傳回的指標中傳回。在不再需要緩衝區之後呼叫 WlanFreeMemory 函式，應該釋放用於 ppvData 參數中緩衝區的記憶體。

與 ppvData 參數所指向之緩衝區相關聯的數據類型取決於 OpCode 參數的值，如下所示：

OpCode	Description
wlan_hosted_network_opcode_connection_settings	傳回 WLAN_HOSTED_NETWORK_CONNECTION_SETTINGS 結構的指標。
wlan_hosted_network_opcode_security_settings	傳回 WLAN_HOSTED_NETWORK_SECURITY_SETTINGS 結構的指標。
wlan_hosted_network_opcode_station_profile	傳回 PWSTR，其中包含連線到無線託管網路的 XML WLAN 配置檔。
wlan_hosted_network_opcode_enable	PBOOL，指出是否傳回無線託管網路。

如果 WlanHostedNetworkQueryProperty 函式在無線託管網路中設定 SSID 之前，在 OpCode 參數中傳遞下列任何值，則函式將會失敗 ，並ERROR_BAD_CONFIGURATION：

wlan_hosted_network_opcode_station_profile
wlan_hosted_network_opcode_connection_settings

任何使用者都可以呼叫 WlanHostedNetworkQueryProperty 函式 來查詢託管的網路屬性。

在 Windows 7 和更新版本上，如果電腦上存在具有裝載網路功能的無線適配卡，操作系統就會安裝虛擬設備。如果計算機具有單一無線網路適配卡，此虛擬設備通常會以「網路 Connections 資料夾」顯示為「無線網路連線 2」，其裝置名稱為「Microsoft Virtual WiFi Miniport 配接器」。此虛擬設備專門用於執行軟體存取點 (SoftAP) 連線，而且不會出現在 WlanEnumInterfaces 函式傳回的清單中。此虛擬設備的存留期會系結至實體無線適配卡。如果實體無線適配卡已停用，也會移除此虛擬設備。此功能也適用於已安裝無線 LAN 服務的 Windows Server 2008 R2。

規格需求

需求	值
最低支援的用戶端	Windows 7 [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2008 R2 [僅限傳統型應用程式]
目標平台	Windows
標頭	wlanapi.h (包含 Wlanapi.h)
程式庫	Wlanapi.lib
Dll	Wlanapi.dll