Функция ConvertInterfaceLuidToNameA (netioapi.h)

Статья
08/25/2023

Функция ConvertInterfaceLuidToNameA преобразует локально уникальный идентификатор (LUID) сетевого интерфейса в имя интерфейса ANSI.

Синтаксис

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API ConvertInterfaceLuidToNameA(
  [in]  const NET_LUID *InterfaceLuid,
  [out] PSTR           InterfaceName,
  [in]  SIZE_T         Length
);

Параметры

[in] InterfaceLuid

Указатель на NET_LUID для сетевого интерфейса.

[out] InterfaceName

Указатель на буфер для хранения строки ANSI, завершаемой значением NULL, содержащей имя интерфейса при успешном возврате функции.

[in] Length

Длина (в байтах) буфера, на который указывает параметр InterfaceName . Это значение должно быть достаточно большим, чтобы вместить имя интерфейса и завершающий символ NULL. Максимальная требуемая длина — NDIS_IF_MAX_STRING_SIZE + 1.

Возвращаемое значение

При успешном выполнении Функция ConvertInterfaceLuidToNameA возвращает NETIO_ERROR_SUCCESS. Любое ненулевое возвращаемое значение указывает на сбой.

Код ошибки	Значение
ERROR_INVALID_PARAMETER	Один из параметров был недопустимым. Эта ошибка возвращается, если параметр InterfaceLuid или InterfaceName имеет значение NULL или если параметр InterfaceLuid был недопустимым.
ERROR_NOT_ENOUGH_MEMORY	Недостаточно места для обработки этой команды. Эта ошибка возвращается, если размер буфера, на который указывает параметр InterfaceName , недостаточно велик, как указано в параметре Length для хранения имени интерфейса.

Функция ConvertInterfaceLuidToNameA не зависит от протокола и работает с сетевыми интерфейсами для протоколов IPv6 и IPv4. ConvertInterfaceLuidToNameA преобразует LUID сетевого интерфейса в имя интерфейса ANSI.

ConvertInterfaceLuidToNameW преобразует LUID сетевого интерфейса в имя интерфейса Юникода.

Максимальная длина имени интерфейса, NDIS_IF_MAX_STRING_SIZE, без завершающего значения NULL объявляется в файле заголовка Ntddndis.h . NDIS_IF_MAX_STRING_SIZE определяется как константой IF_MAX_STRING_SIZE, определенной в файле заголовка Ifdef.h. Файлы заголовков Ntddndis.h и Ifdef.h автоматически включаются в файл заголовка Netioapi.h , который автоматически включается в файл заголовка Iphlpapi.h . Файлы заголовков Ntddndis.h, Ifdef.h и Netioapi.h никогда не следует использовать напрямую.

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2008 [только классические приложения]
Целевая платформа	Windows
Header	netioapi.h (включая Iphlpapi.h)
Библиотека	Iphlpapi.lib
DLL	Iphlpapi.dll