Функция ConvertInterfaceLuidToAlias (netioapi.h)
Функция ConvertInterfaceLuidToAlias преобразует локальный уникальный идентификатор (LUID) для сетевого интерфейса в псевдоним интерфейса.
Синтаксис
IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API ConvertInterfaceLuidToAlias(
[in] const NET_LUID *InterfaceLuid,
[out] PWSTR InterfaceAlias,
[in] SIZE_T Length
);
Параметры
[in] InterfaceLuid
Указатель на NET_LUID сетевого интерфейса.
[out] InterfaceAlias
Указатель на буфер для хранения строки Юникода, завершающейся null, которая содержит псевдоним сетевого интерфейса при успешном возвращении функции.
[in] Length
Длина (в символах) буфера, на который указывает параметр InterfaceAlias . Это значение должно быть достаточно большим, чтобы вместить имя псевдонима сетевого интерфейса и завершающий символ NULL . Максимальная требуемая длина составляет NDIS_IF_MAX_STRING_SIZE + 1.
Возвращаемое значение
При успешном выполнении функция ConvertInterfaceLuidToAlias возвращает NO_ERROR. Любое ненулевое возвращаемое значение указывает на сбой.
| Код ошибки | Значение |
|---|---|
|
Один из параметров был недопустимым. Эта ошибка возвращается, если параметр InterfaceLuid или InterfaceAlias имеет значение NULL или если параметр InterfaceLuid был недопустимым. |
|
Недостаточно места для обработки этой команды. Эта ошибка возвращается, если размер буфера, на который указывает параметр InterfaceAlias , был недостаточно велик, как указано в параметре Length для хранения имени псевдонима. |
Комментарии
Функция ConvertInterfaceLuidToAlias доступна в Windows Vista и более поздних версиях.
Функция ConvertInterfaceLuidToAlias не зависит от протокола и работает с сетевыми интерфейсами для протоколов IPv6 и IPv4.
Максимальная длина имени псевдонима для сетевого интерфейса, 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 |