wlanapi.h) (WlanGetProfileList 函数
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。
如果函数失败，则返回值可能是以下返回代码之一。
| 返回代码 | 说明 |
|---|---|
|
在句柄表中找不到句柄 hClientHandle 。 |
|
参数不正确。 如果出现以下任一情况，则返回此错误：
|
|
没有足够的内存可用于处理此请求并为查询结果分配内存。 |
|
各种错误代码。 |
注解
WlanGetProfileList 函数仅返回有关无线接口上的无线配置文件的基本信息。 无线接口上的无线配置文件列表按首选项顺序检索。 WlanSetProfilePosition 可用于更改无线接口上无线配置文件的首选项顺序。
可以使用 WlanGetProfile 函数检索无线接口上的无线配置文件的更多详细信息。 WlanGetProfileCustomUserData 函数可用于检索无线接口上无线配置文件的自定义用户数据。 可以使用 WlanEnumInterfaces 函数检索本地计算机上的无线接口和关联 GUID 的列表。
WlanGetProfileList 函数为 ppProfileList 参数指向的缓冲区中返回的配置文件列表分配内存。 当不再需要此缓冲区时，调用方负责使用 WlanFreeMemory 函数释放此内存。
带 SP3 的 Windows XP 和适用于 SP2 的 Windows XP 无线 LAN API： 不支持来宾配置文件、具有无线预配服务 (WPS) 身份验证的配置文件，以及具有 Wi-Fi Protected Access-None (WPA-None) 身份验证的配置文件。 WlanGetProfileList 不会返回这些类型的配置文件，即使此类型的配置文件出现在首选配置文件列表中也是如此。
示例
以下示例枚举本地计算机上的无线 LAN 接口，检索每个无线 LAN 接口上的配置文件列表，并从包含WLAN_PROFILE_INFO条目的检索WLAN_PROFILE_INFO_LIST打印值。
注意 如果未安装并启动无线 LAN 服务，此示例将无法在 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) |
| Library | Wlanapi.lib |
| DLL | Wlanapi.dll |
| 可再发行组件 | 带有 SP2 的 Windows XP 无线 LAN API |