Delen via


De functie ConvertInterfaceLuidToAlias

De functie ConvertInterfaceLuidToAlias converteert een lokaal unieke id (LUID) voor een netwerkinterface naar een interfacealias.

Notitie

De ConvertInterfaceXxx API-serie inventariseert id's voor alle interfaces die zijn gebonden aan TCP/IP, waaronder virtuele miniports, lichtgewicht filters, tunneladapters en fysieke interfaces.

Syntaxis

NETIOAPI_API ConvertInterfaceLuidToAlias(
  _In_  const NET_LUID *InterfaceLuid,
  _Out_       PWSTR    InterfaceAlias,
  _In_        SIZE_T   Length
);

Parameters

  • InterfaceLuid [in]
    Een aanwijzer naar een NET_LUID-samenvoeging voor de netwerkinterface.

  • InterfaceAlias [out]
    Een aanwijzer naar een buffer voor het opslaan van de Unicode-tekenreeks die door NULL is beƫindigd. Als ConvertInterfaceLuidToAlias correct wordt geretourneerd, bevat InterfaceAlias de aliasnaam van de netwerkinterface.

  • Lengte [in]
    De lengte, op tekenaantal, van de buffer waarnaar de InterfaceAlias parameter verwijst. Deze waarde moet groot genoeg zijn om de aliasnaam van de netwerkinterface en het afsluitende NULL-teken te bevatten. De maximaal toegestane lengte is NDIS_IF_MAX_STRING_SIZE + 1. Zie de volgende sectie Opmerkingen voor meer informatie over NDIS_IF_MAX_STRING_SIZE.

Retourwaarde

ConvertInterfaceLuidToAlias retourneert STATUS_SUCCESS als de functie slaagt. Als de functie mislukt, retourneert ConvertInterfaceLuidToAlias een van de volgende foutcodes:

Retourcode Beschrijving
STATUS_INVALID_PARAMETER

Een van de parameters is ongeldig. ConvertInterfaceLuidToAlias- retourneert deze fout als InterfaceLuid of InterfaceAliasNULL-is of als InterfaceLuid- ongeldig is.

STATUS_NOT_ENOUGH_MEMORY

Er is onvoldoende opslagruimte beschikbaar. ConvertInterfaceLuidToAlias- retourneert deze fout als de grootte van de buffer waarnaar de InterfaceAlias parameter verwijst, niet zo groot was als is opgegeven in de parameter Length en daarom kan de buffer de aliasnaam niet bevatten.

Opmerkingen

De functie ConvertInterfaceLuidToAlias is protocolonafhankelijk en werkt met netwerkinterfaces voor zowel de IPv6- als IPv4-protocollen.

De maximale lengte van de aliasnaam voor een netwerkinterface, NDIS_IF_MAX_STRING_SIZE, zonder het afsluit-NULL-teken, wordt gedeclareerd in het Ntddndis.h headerbestand. NDIS_IF_MAX_STRING_SIZE wordt gedefinieerd als de IF_MAX_STRING_SIZE constante, die is gedefinieerd in het Ifdef.h headerbestand.

Notitie

De headerbestanden Ntddndis.h en Ifdef.h worden automatisch opgenomen in het headerbestand Netioapi.h. U moet de Ntddndis.h en Ifdef.h headerbestanden nooit rechtstreeks gebruiken.

Eisen

Doelplatform

Universal

Versie

Beschikbaar in Windows Vista en latere versies van de Windows-besturingssystemen.

Rubriek

Netioapi.h (inclusief Netioapi.h)

Bibliotheek

Netio.lib

IRQL

PASSIVE_LEVEL

Zie ook

ConvertInterfaceAliasToLuid-

ConvertInterfaceGuidToLuid-

ConvertInterfaceIndexToLuid-

ConvertInterfaceLuidToGuid-

ConvertInterfaceLuidToIndex

ConvertInterfaceLuidToNameA-

ConvertInterfaceLuidToNameW-

ConvertInterfaceNameToLuidA-

ConvertInterfaceNameToLuidW-

NET_LUID