ConvertInterfaceLuidToAlias, funkcja

Funkcja ConvertInterfaceLuidToAlias konwertuje lokalnie unikatowy identyfikator (LUID) dla interfejsu sieciowego na alias interfejsu.

Nuta

Rodzina interfejsów API ConvertInterfaceXxx wylicza identyfikatory wszystkich interfejsów powiązanych z protokołem TCP/IP, które mogą obejmować wirtualne miniporty, lekkie filtry, karty tunelowe i interfejsy fizyczne.

Składnia

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

Parametry

• InterfaceLuid [in]
  Wskaźnik do unii NET_LUID dla interfejsu sieciowego.

• InterfaceAlias [out]
  Wskaźnik do buforu do przechowywania ciągu Unicode zakończonego wartością NULL. Jeśli funkcja ConvertInterfaceLuidToAlias zostanie zwrócona pomyślnie, InterfaceAlias zawiera nazwę aliasu interfejsu sieciowego.

• długość [in]
  Długość buforu InterfaceAlias wskazuje długość buforu. Ta wartość musi być wystarczająco duża, aby przechowywać nazwę aliasu interfejsu sieciowego i kończący znak NULL. Maksymalna dozwolona długość wynosi NDIS_IF_MAX_STRING_SIZE + 1. Aby uzyskać więcej informacji na temat NDIS_IF_MAX_STRING_SIZE, zobacz następującą sekcję Uwagi.

Wartość zwracana

ConvertInterfaceLuidToAlias zwraca STATUS_SUCCESS, jeśli funkcja powiedzie się. Jeśli funkcja nie powiedzie się, ConvertInterfaceLuidToAlias zwraca jeden z następujących kodów błędów:

Kod powrotny	Opis
STATUS_INVALID_PARAMETER	Jeden z parametrów jest nieprawidłowy. ConvertInterfaceLuidToAlias zwraca ten błąd, jeśli InterfaceLuid lub InterfaceAlias jest NULL lub jeśli InterfaceLuid jest nieprawidłowy.
STATUS_NOT_ENOUGH_MEMORY	Za mało miejsca do magazynowania. ConvertInterfaceLuidToAlias zwraca ten błąd, jeśli rozmiar buforu, do którego wskazuje parametr InterfaceAlias, nie był tak duży, jak określono w parametrze długości i dlatego bufor nie mógł przechowywać nazwy aliasu.

Uwagi

Funkcja ConvertInterfaceLuidToAlias jest niezależna od protokołu i współpracuje z interfejsami sieciowymi zarówno dla protokołów IPv6, jak i IPv4.

Maksymalna długość nazwy aliasu interfejsu sieciowego, NDIS_IF_MAX_STRING_SIZE bez znaku null zakończenia, jest zadeklarowana w pliku nagłówka Ntddndis.h. NDIS_IF_MAX_STRING_SIZE jest zdefiniowana jako stała IF_MAX_STRING_SIZE zdefiniowana w pliku nagłówka Ifdef.h.

Nuta

Pliki nagłówków Ntddndis.h i Ifdef.h są automatycznie dołączane do pliku nagłówka Netioapi.h. Nigdy nie należy używać plików nagłówków Ntddndis.h i Ifdef.h bezpośrednio.

Wymagania

Platforma docelowa	universal
Wersja	Dostępne w systemie Windows Vista i nowszych wersjach systemów operacyjnych Windows.
Nagłówek	Netioapi.h (include Netioapi.h)
Biblioteka	Netio.lib
IRQL	PASSIVE_LEVEL

Zobacz też

ConvertInterfaceAliasToLuid

ConvertInterfaceGuidToLuid

ConvertInterfaceIndexToLuid

ConvertInterfaceLuidToGuid

ConvertInterfaceLuidToIndex

ConvertInterfaceLuidToNameA

ConvertInterfaceLuidToNameW

ConvertInterfaceNameToLuidA

ConvertInterfaceNameToLuidW

NET_LUID