共用方式為

WlanEnumInterfaces 函式 (wlanapi.h)

  • 發行項

WlanEnumInterfaces 函式會列舉本機電腦上目前啟用的所有無線區域網路 介面。

語法

DWORD WlanEnumInterfaces(
  [in]  HANDLE                    hClientHandle,
  [in]  PVOID                     pReserved,
  [out] PWLAN_INTERFACE_INFO_LIST *ppInterfaceList
);

參數

[in] hClientHandle

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

[in] pReserved

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

[out] ppInterfaceList

要接收 WLAN_INTERFACE_INFO_LIST結構中 無線區域網路 介面傳回清單之指標的儲存體指標。

如果呼叫成功，則 WlanEnumInterfaces函式會配置傳回之WLAN_INTERFACE_INFO_LIST的緩衝區。

傳回值

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

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

傳回碼 描述
ERROR_INVALID_PARAMETER
 參數不正確。 如果 hClientHandle 或 ppInterfaceList 參數為 Null，就會傳回此錯誤。 如果 pReserved 不是 Null，就會傳回此錯誤。 如果 hClientHandle 參數無效，也會傳回此錯誤。
ERROR_INVALID_HANDLE
 控制碼資料表中找不到控制碼 hClientHandle 。
RPC_STATUS
 各種錯誤碼。
ERROR_NOT_ENOUGH_MEMORY
 沒有足夠的記憶體可用來處理此要求，並配置查詢結果的記憶體。

備註

WlanEnumInterfaces 函式會為函式成功時，ppInterfaceList參數所指向之緩衝區中傳回的介面清單配置記憶體。 不再需要緩衝區之後呼叫WlanFreeMemory函式，即可釋放ppInterfaceList參數所指向之緩衝區的記憶體。

範例

下列範例會列舉本機電腦上的無線區域網路 介面，並從擷取 的 WLAN_INTERFACE_INFO_LIST 結構和列舉 的 WLAN_INTERFACE_INFO 結構列印值。

注意 如果未安裝並啟動無線區域網路 服務，此範例將無法載入 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;
    int iRet = 0;
    
    WCHAR GuidString[40] = {0};
     
    int i;

    /* variables used for WlanEnumInterfaces  */
    
    PWLAN_INTERFACE_INFO_LIST pIfList = NULL;
    PWLAN_INTERFACE_INFO pIfInfo = NULL;

    
    dwResult = WlanOpenHandle(dwMaxClient, NULL, &dwCurVersion, &hClient); 
    if (dwResult != ERROR_SUCCESS)  {
        wprintf(L"WlanOpenHandle failed with error: %u\n", dwResult);
        // FormatMessage can be used to find out why the function failed
        return 1;
    }
    
    dwResult = WlanEnumInterfaces(hClient, NULL, &pIfList); 
    if (dwResult != ERROR_SUCCESS)  {
        wprintf(L"WlanEnumInterfaces failed with error: %u\n", dwResult);
        // FormatMessage can be used to find out why the function failed
        return 1;
    }
    else {
        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[%d]:\t %lu\n", i, i);
            iRet = StringFromGUID2(pIfInfo->InterfaceGuid, (LPOLESTR) &GuidString, 39); 
            // For c rather than C++ source code, the above line needs to be
            // iRet = StringFromGUID2(&pIfInfo->InterfaceGuid, (LPOLESTR) &GuidString, 39); 
            if (iRet == 0)
                wprintf(L"StringFromGUID2 failed\n");
            else {
                wprintf(L"  InterfaceGUID[%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");
        }
    }

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

規格需求

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

另請參閱

WLAN_INTERFACE_INFO

WLAN_INTERFACE_INFO_LIST

WlanFreeMemory