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