WlanGetProfileList 函式 (wlanapi.h)

發行項
03/15/2023

WlanGetProfileList函式會依喜好設定順序擷取配置檔案清單。

語法

DWORD WlanGetProfileList(
  [in]  HANDLE                  hClientHandle,
  [in]  const GUID              *pInterfaceGuid,
  [in]  PVOID                   pReserved,
  [out] PWLAN_PROFILE_INFO_LIST *ppProfileList
);

參數

[in] hClientHandle

用戶端的會話控制碼，由先前呼叫 WlanOpenHandle 函式取得。

[in] pInterfaceGuid

無線介面的 GUID。

您可以使用 WlanEnumInterfaces 函式來擷取本機電腦上無線介面的 GUID 清單。

[in] pReserved

保留供未來使用。必須設定為 Null。

[out] ppProfileList

包含設定檔資訊清單的PWLAN_PROFILE_INFO_LIST 結構。

傳回值

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

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

傳回碼	描述
ERROR_INVALID_HANDLE	控制碼資料表中找不到控制碼 hClientHandle 。
ERROR_INVALID_PARAMETER	參數不正確。如果發生下列任一情況，就會傳回此錯誤： hClientHandle 為 Null。 pInterfaceGuid 為 Null。 ppProfileList 為 Null。 pReserved 不是 Null。
ERROR_NOT_ENOUGH_MEMORY	沒有足夠的記憶體可用來處理此要求，並配置查詢結果的記憶體。
RPC_STATUS	各種錯誤碼。

備註

WlanGetProfileList函式只會傳回無線介面上無線設定檔的基本資訊。無線介面上的無線配置檔案清單會依喜好設定順序擷取。 WlanSetProfilePosition可用來變更無線介面上無線設定檔的喜好設定順序。

您可以使用 WlanGetProfile 函式來擷取無線介面上無線設定檔的詳細資訊。 WlanGetProfileCustomUserData函式可用來擷取無線介面上無線設定檔的自訂使用者資料。您可以使用 WlanEnumInterfaces 函式來擷取本機電腦上的無線介面和相關聯的 GUID 清單。

WlanGetProfileList函式會為ppProfileList參數所指向之緩衝區中傳回的配置檔案清單配置記憶體。呼叫端負責在不再需要此緩衝區時，使用 WlanFreeMemory 函式釋放此記憶體。

Windows XP 搭配 SP3 和適用于 Windows XP 的無線區域網路 API 與 SP2： 不支援客體設定檔、無線布建服務 (WPS) 驗證的設定檔，以及 Wi-Fi 受保護 Access-None (WPA-None) 驗證的設定檔。即使此類型的設定檔出現在慣用配置檔案清單中， WlanGetProfileList也不會傳回這些類型的設定檔。

範例

下列範例會列舉本機電腦上的無線區域網路介面、擷取每個無線區域網路介面上的配置檔案清單，並從包含WLAN_PROFILE_INFO專案的擷取WLAN_PROFILE_INFO_LIST列印值。

注意如果未安裝並啟動無線區域網路服務，此範例將無法載入 Windows Server 2008 和 Windows Server 2008 R2。

#ifndef UNICODE
#define UNICODE
#endif

#include <windows.h>
#include <wlanapi.h>
#include <objbase.h>
#include <wtypes.h>

#include <stdio.h>
#include <stdlib.h>

// Need to link with Wlanapi.lib and Ole32.lib
#pragma comment(lib, "wlanapi.lib")
#pragma comment(lib, "ole32.lib")


int wmain()
{

    // Declare and initialize variables.

    HANDLE hClient = NULL;
    DWORD dwMaxClient = 2;      //    
    DWORD dwCurVersion = 0;
    DWORD dwResult = 0;
    DWORD dwRetVal = 0;
    int iRet = 0;
    
    WCHAR GuidString[39] = {0};

    unsigned int i, j;

    /* variables used for WlanEnumInterfaces  */

    PWLAN_INTERFACE_INFO_LIST pIfList = NULL;
    PWLAN_INTERFACE_INFO pIfInfo = NULL;

    PWLAN_PROFILE_INFO_LIST pProfileList = NULL;
    PWLAN_PROFILE_INFO pProfile = NULL;

    dwResult = WlanOpenHandle(dwMaxClient, NULL, &dwCurVersion, &hClient);
    if (dwResult != ERROR_SUCCESS) {
        wprintf(L"WlanOpenHandle failed with error: %u\n", dwResult);
        return 1;
        // You can use FormatMessage here to find out why the function failed
    }

    dwResult = WlanEnumInterfaces(hClient, NULL, &pIfList);
    if (dwResult != ERROR_SUCCESS) {
        wprintf(L"WlanEnumInterfaces failed with error: %u\n", dwResult);
        return 1;
        // You can use FormatMessage here to find out why the function failed
    } else {
        wprintf(L"WLAN_INTERFACE_INFO_LIST for this system\n");

        wprintf(L"Num Entries: %lu\n", pIfList->dwNumberOfItems);
        wprintf(L"Current Index: %lu\n", pIfList->dwIndex);
        for (i = 0; i < (int) pIfList->dwNumberOfItems; i++) {
            pIfInfo = (WLAN_INTERFACE_INFO *) &pIfList->InterfaceInfo[i];
            wprintf(L"  Interface Index[%u]:\t %lu\n", i, i);
            iRet = StringFromGUID2(pIfInfo->InterfaceGuid, (LPOLESTR) &GuidString, 
                sizeof(GuidString)/sizeof(*GuidString)); 
            // For c rather than C++ source code, the above line needs to be
            // iRet = StringFromGUID2(&pIfInfo->InterfaceGuid, (LPOLESTR) &GuidString, 
            //     sizeof(GuidString)/sizeof(*GuidString)); 
            if (iRet == 0)
                wprintf(L"StringFromGUID2 failed\n");
            else {
                wprintf(L"  Interface GUID[%d]: %ws\n",i, GuidString);
            }    
            wprintf(L"  Interface Description[%d]: %ws", i, 
                pIfInfo->strInterfaceDescription);
            wprintf(L"\n");
            wprintf(L"  Interface State[%d]:\t ", i);
            switch (pIfInfo->isState) {
            case wlan_interface_state_not_ready:
                wprintf(L"Not ready\n");
                break;
            case wlan_interface_state_connected:
                wprintf(L"Connected\n");
                break;
            case wlan_interface_state_ad_hoc_network_formed:
                wprintf(L"First node in a ad hoc network\n");
                break;
            case wlan_interface_state_disconnecting:
                wprintf(L"Disconnecting\n");
                break;
            case wlan_interface_state_disconnected:
                wprintf(L"Not connected\n");
                break;
            case wlan_interface_state_associating:
                wprintf(L"Attempting to associate with a network\n");
                break;
            case wlan_interface_state_discovering:
                wprintf(L"Auto configuration is discovering settings for the network\n");
                break;
            case wlan_interface_state_authenticating:
                wprintf(L"In process of authenticating\n");
                break;
            default:
                wprintf(L"Unknown state %ld\n", pIfInfo->isState);
                break;
            }
            wprintf(L"\n");

            dwResult = WlanGetProfileList(hClient,
                                             &pIfInfo->InterfaceGuid,
                                             NULL, 
                                             &pProfileList);

            if (dwResult != ERROR_SUCCESS) {
                wprintf(L"WlanGetProfileList failed with error: %u\n",
                        dwResult);
                dwRetVal = 1;
                // You can use FormatMessage to find out why the function failed
            } else {
                wprintf(L"WLAN_PROFILE_INFO_LIST for this interface\n");

                wprintf(L"  Num Entries: %lu\n\n", pProfileList->dwNumberOfItems);

                for (j = 0; j < pProfileList->dwNumberOfItems; j++) {
                    pProfile =
                        (WLAN_PROFILE_INFO *) & pProfileList->ProfileInfo[j];

                    wprintf(L"  Profile Name[%u]:  %ws\n", j, pProfile->strProfileName);
                    
                    wprintf(L"  Flags[%u]:\t    0x%x", j, pProfile->dwFlags);
                    if (pProfile->dwFlags & WLAN_PROFILE_GROUP_POLICY)
                        wprintf(L"   Group Policy");
                    if (pProfile->dwFlags & WLAN_PROFILE_USER)
                        wprintf(L"   Per User Profile");
                    wprintf(L"\n");    

                    wprintf(L"\n");
                }
            }
        }

    }
    if (pProfileList != NULL) {
        WlanFreeMemory(pProfileList);
        pProfileList = NULL;
    }

    if (pIfList != NULL) {
        WlanFreeMemory(pIfList);
        pIfList = NULL;
    }

    return dwRetVal;
}

規格需求


最低支援的用戶端	Windows Vista、Windows XP 與 SP3 [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2008 [僅限傳統型應用程式]
目標平台	Windows
標頭	wlanapi.h (包含 Wlanapi.h)
程式庫	Wlanapi.lib
Dll	Wlanapi.dll
可轉散發套件	適用于 Windows XP 與 SP2 的無線區域網路 API