Función GetAdapterIndex (iphlpapi.h)

Artículo
03/05/2024

La función GetAdapterIndex obtiene el índice de un adaptador, dado su nombre.

Sintaxis

IPHLPAPI_DLL_LINKAGE DWORD GetAdapterIndex(
  [in]      LPWSTR AdapterName,
  [in, out] PULONG IfIndex
);

Parámetros

[in] AdapterName

Puntero a una cadena Unicode que especifica el nombre del adaptador.

[in, out] IfIndex

Puntero a una variable ULONG que apunta al índice del adaptador.

Valor devuelto

Si la función se realiza correctamente, el valor devuelto es NO_ERROR.

Si se produce un error en la función, use FormatMessage para obtener la cadena de mensaje para el error devuelto.

Comentarios

Hasta que un adaptador esté totalmente deshabilitado, la función GetAdapterIndex notifica el adaptador como está presente. Por ejemplo, la función NotifyAddrChange puede indicar que se ha quitado la dirección IP de un adaptador deshabilitado recientemente, pero GetAdapterIndex sigue notificando un índice de adaptador hasta que se complete el proceso de deshabilitación del adaptador.

Cuando uno o varios adaptadores están presentes en el sistema, GetAdapterIndex devuelve ERROR_DEV_NOT_EXIST cuando el adaptador que se consulta no existe. Cuando no hay adaptadores presentes, la función GetAdapterIndex devuelve ERROR_NO_DATA.

El índice del adaptador puede cambiar cuando un adaptador está deshabilitado y, a continuación, habilitado, o en otras circunstancias, y no debe considerarse persistente.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	iphlpapi.h
Library	Iphlpapi.lib
Archivo DLL	Iphlpapi.dll