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 はローカルインターフェイスインデックスを返します。失敗した場合は、0 が返されます。

注釈

if_nametoindex関数は、Windows Vista 以降で使用できます。

if_nametoindex関数は、インターフェイス名を対応するインデックスにマップします。この関数は、RFC 2553 の IETF で説明されているように、IPv6 の基本的なソケット拡張機能の一部として設計されています。詳細については、「http://www.ietf.org/rfc/rfc2553.txt」を参照してください。

if_nametoindex関数は、Unix 環境でのアプリケーションの移植性のために実装されていますが、ConvertInterface 関数が推奨されます。 if_nametoindex関数を ConvertInterfaceNameToLuidA 関数の呼び出しに置き換えて、ANSI インターフェイス名をNET_LUIDに変換し、その後に ConvertInterfaceLuidToIndex を呼び出して、NET_LUIDをローカルインターフェイスインデックスに変換できます。

if_nametoindex関数が失敗し、0 を返した場合、エラーコードを特定することはできません。

要件

要件	値
サポートされている最小のクライアント	Windows Vista [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows Server 2008 [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	netioapi.h (Iphlpapi.h を含む)
Library	Iphlpapi.lib
[DLL]	Iphlpapi.dll