if_indextoname函式 (netioapi.h)

發行項
02/29/2024

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

語法

IPHLPAPI_DLL_LINKAGE PCHAR NETIOAPI_API_ if_indextoname(
  [in]  NET_IFINDEX InterfaceIndex,
  [out] PCHAR       InterfaceName
);

參數

[in] InterfaceIndex

網路介面的本機索引。

[out] InterfaceName

緩衝區的指標，用來保存函式傳回成功時包含介面名稱的 NULL終止 ANSI 字串。此參數所指向之緩衝區的長度，以位元組為單位必須等於或大於 IF_NAMESIZE。

傳回值

成功時， if_indextoname 傳回包含介面名稱的 NULL終止 ANSI 字串指標。失敗時，會傳回 NULL 指標。

備註

Windows Vista 和更新版本提供 if_indextoname 函式。

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

if_indextoname函式是針對具有 Unix 環境的應用程式可移植性所實作，但建議使用 ConvertInterface 函式。 if_indextoname函式可以取代為 ConvertInterfaceIndexToLuid 函式的呼叫，將介面索引轉換成NET_LUID，後面接著對 ConvertInterfaceLuidToNameA 的呼叫，將NET_LUID轉換成 ANSI 介面名稱。

如果 if_indextoname 失敗並傳回 NULL 指標，則無法判斷錯誤碼。

InterfaceName 參數指向之緩衝區的長度，以位元組為單位必須等於或大於 IF_NAMESIZE，Netioapi.h 頭檔中所宣告的值等於 NDIS_IF_MAX_STRING_SIZE。在 Ntddndis.h 頭檔中宣告沒有終止 NULL 的介面名稱長度上限NDIS_IF_MAX_STRING_SIZE。 NDIS_IF_MAX_STRING_SIZE定義為 Ifdef.h 頭檔中定義的IF_MAX_STRING_SIZE常數。 Ntddndis.h 和 Ifdef.h 頭文件會自動包含在 Netioapi.h 頭檔中，Iphlpapi.h 頭文件會自動包含此頭檔。不應該直接使用 Ntddndis.h、 Ifdef.h 和 Netioapi.h 頭檔。

規格需求

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