if_nametoindex 函式 (netioapi.h)

發行項
02/29/2024

if_nametoindex函式會將網路介面的 ANSI 介面名稱轉換為介面的本機索引。

語法

IPHLPAPI_DLL_LINKAGE NET_IFINDEX NETIOAPI_API_ if_nametoindex(
  [in] PCSTR InterfaceName
);

參數

[in] InterfaceName

包含介面名稱之 NULL 終止 ANSI 字串的指標。

傳回值

成功時， if_nametoindex 會傳回本機介面索引。失敗時，會傳回零。

備註

If_nametoindex函式可在 Windows Vista 和更新版本上使用。

if_nametoindex函式會將介面名稱對應至其對應的索引。此函式是設計為 IPv6 的基本套接字延伸模組的一部分，如 RFC 2553 中的 IETF 所述。如需詳細資訊，請參閱http://www.ietf.org/rfc/rfc2553.txt。

if_nametoindex函式是針對具有 Unix 環境之應用程式的可移植性而實作，但偏好使用 ConvertInterface 函式。 if_nametoindex函式可以透過呼叫 ConvertInterfaceNameToLuidA 函式來取代，將 ANSI 介面名稱轉換成NET_LUID，後面接著 ConvertInterfaceLuidToIndex 的呼叫，將NET_LUID轉換成本機介面索引。

如果 if_nametoindex 函式失敗並傳回零，則無法判斷錯誤碼。

規格需求

需求	值
最低支援的用戶端	Windows Vista [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2008 [僅限傳統型應用程式]
目標平台	Windows
標頭	netioapi.h (包含 Iphlpapi.h)
程式庫	Iphlpapi.lib
Dll	Iphlpapi.dll