Функция ConvertInterfaceLuidToAlias
Функция ConvertInterfaceLuidToAlias преобразует локально уникальный идентификатор (LUID) для сетевого интерфейса в псевдоним интерфейса.
Примечание
Семейство API ConvertInterfaceXxx перечисляет идентификаторы по всем интерфейсам, привязанным к TCP/IP, которые могут включать виртуальные минипорты, упрощенные фильтры, адаптеры туннеля и физические интерфейсы.
Синтаксис
NETIOAPI_API ConvertInterfaceLuidToAlias(
_In_ const NET_LUID *InterfaceLuid,
_Out_ PWSTR InterfaceAlias,
_In_ SIZE_T Length
);
Параметры
InterfaceLuid [in]
Указатель на NET_LUID объединение для сетевого интерфейса.InterfaceAlias [out]
Указатель на буфер для хранения строки Юникода, завершаемой значением NULL. Если функция ConvertInterfaceLuidToAlias возвращает успешно, InterfaceAlias содержит псевдоним сетевого интерфейса.Длина [in]
Длина буфера по количеству символов, на который указывает параметр InterfaceAlias . Это значение должно быть достаточно большим для хранения псевдонима сетевого интерфейса и завершающего символа NULL. Максимально допустимая длина составляет NDIS_IF_MAX_STRING_SIZE + 1. Дополнительные сведения о NDIS_IF_MAX_STRING_SIZE см. в следующем разделе Примечания.
Возвращаемое значение
ConvertInterfaceLuidToAlias возвращает STATUS_SUCCESS, если функция выполнена успешно. Если функция завершается сбоем, Функция ConvertInterfaceLuidToAlias возвращает один из следующих кодов ошибок:
| Код возврата | Описание |
|---|---|
| STATUS_INVALID_PARAMETER | Один из параметров является недопустимым. ConvertInterfaceLuidToAlias возвращает эту ошибку , если InterfaceLuid или InterfaceAlias имеет значение NULL или если InterfaceLuid недопустим. |
| STATUS_NOT_ENOUGH_MEMORY | Недостаточно хранилища. ConvertInterfaceLuidToAlias возвращает эту ошибку , если размер буфера, на который указывает параметр InterfaceAlias , был не таким большим, как указано в параметре Length , и, следовательно, буфер не мог содержать имя псевдонима. |
Комментарии
Функция 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 . Никогда не следует использовать файлы заголовков Ntddndis.h и Ifdef.h напрямую.
Требования
Целевая платформа |
Универсальное |
Версия |
Доступно в Windows Vista и более поздних версиях операционных систем Windows. |
Заголовок |
Netioapi.h (включая Netioapi.h) |
Библиотека |
Netio.lib |
IRQL |
PASSIVE_LEVEL |