Función GetUnicastIpAddressEntry
La función GetUnicastIpAddressEntry recupera información de una entrada de dirección IP de unidifusión existente en un equipo local.
Sintaxis
NETIOAPI_API GetUnicastIpAddressEntry(
_Inout_ PMIB_UNICASTIPADDRESS_ROW Row
);
Parámetros
- Fila [in, out]
Puntero a una entrada de estructura de MIB_UNICASTIPADDRESS_ROW para una entrada de dirección IP de unidifusión. Si la devolución se realiza correctamente, esta estructura se actualiza con las propiedades de una dirección IP de unidifusión existente.
Valor devuelto
GetUnicastIpAddressEntry devuelve STATUS_SUCCESS si la función se realiza correctamente.
Si se produce un error en la función, GetUnicastIpAddressEntry devuelve uno de los siguientes códigos de error:
| Código devuelto | Descripción |
|---|---|
| STATUS_INVALID_PARAMETER | Se pasó un parámetro no válido a la función. Este error se devuelve si se pasa un puntero NULL en el parámetro Row , el miembro Address de la estructura MIB_UNICASTIPADDRESS_ROW a la que apunta el parámetro Row no se estableció en una dirección IPv4 o IPv6 de unidifusión válida, o los miembros InterfaceLuid e InterfaceIndex de la estructura de MIB_UNICASTIPADDRESS_ROW no se especificaron. |
| STATUS_NOT_FOUND | No se encontró la interfaz especificada. Este error se devuelve si la función no encuentra la interfaz de red especificada por el miembro InterfaceLuid o InterfaceIndex de la estructura MIB_UNICASTIPADDRESS_ROW a la que apunta el parámetro Row . |
| STATUS_NOT_SUPPORTED | No se admite la solicitud. Este error se devuelve si no hay ninguna pila IPv4 ubicada en el equipo local y se especificó una dirección IPv4 en el miembro Address de la estructura MIB_UNICASTIPADDRESS_ROW a la que apunta el parámetro Row o si no hay ninguna pila IPv6 ubicada en el equipo local y se especificó una dirección IPv6 en el miembro Address . |
| Otros | Use la función FormatMessage para obtener la cadena de mensaje para el error devuelto. |
Observaciones
La función GetUnicastIpAddressEntry se usa normalmente para recuperar una entrada de estructura de MIB_UNICASTIPADDRESS_ROW existente que se va a modificar. A continuación, un controlador puede cambiar los miembros de la entrada MIB_UNICASTIPADDRESS_ROW que quiere modificar y, a continuación, llamar a la función SetUnicastIpAddressEntry .
En la entrada, el controlador debe inicializar los siguientes miembros de la estructura MIB_UNICASTIPADDRESS_ROW a la que apunta el parámetro Row .
Dirección
Establézcalo en una dirección y familia IPv6 IPv4 o IPv6 válida.InterfaceLuid o InterfaceIndex
Estos miembros se usan en el orden indicado anteriormente. Por lo tanto, si se especifica InterfaceLuid , este miembro se usa para determinar la interfaz. Si no se estableció ningún valor para el miembro InterfaceLuid (el valor de este miembro se estableció en cero), el miembro InterfaceIndex se usa a continuación para determinar la interfaz.
Cuando la llamada se realiza correctamente, GetUnicastIpAddressEntry recupera las demás propiedades de la dirección IP de unidifusión y rellena la estructura MIB_UNICASTIPADDRESS_ROW a la que apunta el parámetro Row .
El controlador puede llamar a la función GetUnicastIpAddressTable para enumerar las entradas de dirección IP de unidifusión en un equipo local.
Requisitos
Plataforma de destino |
Universal |
Versión |
Disponible en Windows Vista y versiones posteriores de los sistemas operativos Windows. |
Encabezado |
Netioapi.h (incluya Netioapi.h) |
Biblioteca |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |