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