Función GetPerAdapterInfo (iphlpapi.h)

  • Artículo

La función GetPerAdapterInfo recupera información sobre el adaptador correspondiente a la interfaz especificada.

Sintaxis

IPHLPAPI_DLL_LINKAGE DWORD GetPerAdapterInfo(
  [in]  ULONG                IfIndex,
  [out] PIP_PER_ADAPTER_INFO pPerAdapterInfo,
  [in]  PULONG               pOutBufLen
);

Parámetros

[in] IfIndex

Índice de una interfaz. La función GetPerAdapterInfo recupera información del adaptador correspondiente a esta interfaz.

[out] pPerAdapterInfo

Puntero a una estructura de IP_PER_ADAPTER_INFO que recibe información sobre el adaptador.

[in] pOutBufLen

Puntero a una variable ULONG que especifica el tamaño de la estructura de IP_PER_ADAPTER_INFO . Si este tamaño no es suficiente para contener la información, GetPerAdapterInfo rellena esta variable con el tamaño necesario y devuelve un código de error de ERROR_BUFFER_OVERFLOW.

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 es uno de los siguientes códigos de error.

Código devuelto Descripción
ERROR_BUFFER_OVERFLOW
 El tamaño del búfer indicado por el parámetro pOutBufLen es demasiado pequeño para contener la información del adaptador. El parámetro pOutBufLen apunta al tamaño necesario.
ERROR_INVALID_PARAMETER
 El parámetro pOutBufLen es NULL o el proceso de llamada no tiene acceso de lectura y escritura a la memoria a la que apunta pOutBufLen o el proceso de llamada no tiene acceso de escritura a la memoria a la que apunta el parámetro pAdapterInfo .
ERROR_NOT_SUPPORTED

GetPerAdapterInfo no es compatible con el sistema operativo que se ejecuta en el equipo local.
Otros
 Si se produce un error en la función, use FormatMessage para obtener la cadena de mensaje para el error devuelto.
 
 

Comentarios

Un índice de adaptador puede cambiar cuando el 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 [aplicaciones de escritorio | Aplicaciones para UWP]
Servidor mínimo compatible Windows 2000 Server [aplicaciones de escritorio | Aplicaciones para UWP]
Plataforma de destino Windows
Encabezado iphlpapi.h
Library Iphlpapi.lib
Archivo DLL Iphlpapi.dll

Consulte también

Referencia de la función auxiliar de IP

Página de inicio del asistente de IP

IP_PER_ADAPTER_INFO