if_indextoname, functie

De functie if_indextoname converteert de lokale index voor een netwerkinterface naar de naam van de ANSI-interface.

Syntaxis

PCHAR NETIOAPI_API_ if_indextoname(
  _In_  NET_IFINDEX InterfaceIndex,
  _Out_ PCHAR       InterfaceName
);

Parameters

• InterfaceIndex [in]
  De lokale index voor een netwerkinterface.

• InterfaceName [out]
  Een aanwijzer naar een buffer voor het opslaan van de ANSI-tekenreeks die door NULL is beëindigd. Als if_indextoname slaagt, bevat InterfaceName de naam van de ANSI-interface. De lengte in bytes van de buffer waarnaar deze parameter verwijst, moet gelijk zijn aan of groter zijn dan IF_NAMESIZE. Zie de volgende sectie Opmerkingen voor meer informatie over IF_NAMESIZE.

Retourwaarde

Als deze functie slaagt, retourneert if_indextoname een aanwijzer naar een DOOR NULL beëindigde ANSI-tekenreeks die de interfacenaam bevat. Als deze functie mislukt, retourneert if_indextoname een NULL- aanwijzer

Opmerkingen

De functie if_indextoname wijst een interface-index toe aan de bijbehorende naam. Deze functie is ontworpen als onderdeel van eenvoudige socketextensies voor IPv6, zoals beschreven door de IETF in RFC 2553.

De if_indextoname-functie is geïmplementeerd voor de draagbaarheid van stuurprogramma's met Unix-omgevingen, maar de ConvertInterfaceXxx-functies zijn de voorkeursmethode om netwerkinterface-id's te converteren. U kunt de if_indextoname functie vervangen door een aanroep naar de functie ConvertInterfaceIndexToLuid om een interfaceindex te converteren naar een NET_LUID-samenvoeging, gevolgd door een aanroep naar de functie ConvertInterfaceLuidToNameA om NET_LUID te converteren naar de naam van de ANSI-interface.

De lengte in bytes van de buffer waarnaar de InterfaceName parameter verwijst, moet gelijk zijn aan of groter zijn dan IF_NAMESIZE. De IF_NAMESIZE-waarde wordt gedefinieerd in het headerbestand Netioapi.h als gelijk aan NDIS_IF_MAX_STRING_SIZE. De maximale lengte van een interfacenaam, NDIS_IF_MAX_STRING_SIZE, zonder het afsluitende NULL-teken wordt gedeclareerd in het headerbestand Ntddndis.h. De NDIS_IF_MAX_STRING_SIZE wordt gedefinieerd als de IF_MAX_STRING_SIZE constante die is gedefinieerd in het headerbestand Ifdef.h.

Als de functie if_indextoname mislukt en een NULL- aanwijzer retourneert, kunt u geen foutcode bepalen.

Eisen

Zie ook

ConvertInterfaceIndexToLuid-

ConvertInterfaceLuidToNameA-

NET_LUID