Función WlanEnumInterfaces (wlanapi.h)
La función WlanEnumInterfaces enumera todas las interfaces LAN inalámbricas habilitadas actualmente en el equipo local.
Sintaxis
DWORD WlanEnumInterfaces(
[in] HANDLE hClientHandle,
[in] PVOID pReserved,
[out] PWLAN_INTERFACE_INFO_LIST *ppInterfaceList
);
Parámetros
[in] hClientHandle
Identificador de sesión del cliente, obtenido por una llamada anterior a la función WlanOpenHandle .
[in] pReserved
Reservado para uso futuro. Este parámetro debe establecerse en NULL.
[out] ppInterfaceList
Puntero al almacenamiento de un puntero para recibir la lista devuelta de interfaces LAN inalámbricas en una estructura WLAN_INTERFACE_INFO_LIST .
La función WlanEnumInterfaces asigna el búfer del WLAN_INTERFACE_INFO_LIST devuelto si la llamada se realiza correctamente.
Valor devuelto
Si la función se ejecuta correctamente, el valor devuelto es ERROR_SUCCESS.
Si se produce un error en la función, el valor devuelto puede ser uno de los siguientes códigos de retorno.
| Código devuelto | Descripción |
|---|---|
|
Un parámetro es incorrecto. Este error se devuelve si el parámetro hClientHandle o ppInterfaceList es NULL. Este error se devuelve si pReserved no es NULL. Este error también se devuelve si el parámetro hClientHandle no es válido. |
|
No se encontró el identificador hClientHandle en la tabla handle. |
|
Varios códigos de error. |
|
No hay suficiente memoria disponible para procesar esta solicitud y asignar memoria para los resultados de la consulta. |
Observaciones
La función WlanEnumInterfaces asigna memoria para la lista de interfaces devueltas que se devuelven en el búfer señalado por el parámetro ppInterfaceList cuando la función se realiza correctamente. La memoria usada para el búfer a la que apunta el parámetro ppInterfaceList debe liberarse llamando a la función WlanFreeMemory después de que el búfer ya no sea necesario.
Ejemplos
En el ejemplo siguiente se enumeran las interfaces LAN inalámbricas en el equipo local y se imprimen valores de la estructura de WLAN_INTERFACE_INFO_LIST recuperada y las estructuras de WLAN_INTERFACE_INFO enumeradas.
#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;
}
Requisitos
| Cliente mínimo compatible | Windows Vista, Windows XP con SP3 [solo aplicaciones de escritorio] |
| Servidor mínimo compatible | Windows Server 2008 [solo aplicaciones de escritorio] |
| Plataforma de destino | Windows |
| Encabezado | wlanapi.h (incluya Wlanapi.h) |
| Library | Wlanapi.lib |
| Archivo DLL | Wlanapi.dll |
| Redistribuible | API de LAN inalámbrica para Windows XP con SP2 |