Функция GetAdapterIndex (iphlpapi.h)

Статья
08/24/2023

Функция GetAdapterIndex получает индекс адаптера по его имени.

Синтаксис

IPHLPAPI_DLL_LINKAGE DWORD GetAdapterIndex(
  [in]      LPWSTR AdapterName,
  [in, out] PULONG IfIndex
);

Параметры

[in] AdapterName

Указатель на строку Юникода, указывающую имя адаптера.

[in, out] IfIndex

Указатель на переменную ULONG , указывающую на индекс адаптера.

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

Если функция выполняется успешно, возвращаемое значение будет NO_ERROR.

Если функция завершается сбоем, используйте FormatMessage , чтобы получить строку сообщения для возвращаемой ошибки.

Пока адаптер не будет полностью отключен, функция GetAdapterIndex сообщает о наличии адаптера. Например, функция NotifyAddrChange может указать, что IP-адрес недавно отключенного адаптера удален, но GetAdapterIndex продолжает сообщать индекс адаптера до тех пор, пока не завершится процесс отключения адаптера.

При наличии в системе одного или нескольких адаптеров GetAdapterIndex возвращает ERROR_DEV_NOT_EXIST, когда запрашиваемый адаптер не существует. Если адаптеры отсутствуют, функция GetAdapterIndex возвращает ERROR_NO_DATA.

Индекс адаптера может изменяться при отключении и включении адаптера или при других обстоятельствах и не должен считаться постоянным.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	iphlpapi.h
Библиотека	Iphlpapi.lib
DLL	Iphlpapi.dll