GetAdapterIndex 関数 (iphlpapi.h)
GetAdapterIndex 関数は、その名前を指定してアダプターのインデックスを取得します。
構文
IPHLPAPI_DLL_LINKAGE DWORD GetAdapterIndex(
[in] LPWSTR AdapterName,
[in, out] PULONG IfIndex
);
パラメーター
[in] AdapterName
アダプターの名前を指定する Unicode 文字列へのポインター。
[in, out] IfIndex
アダプターのインデックスを指す ULONG 変数へのポインター。
戻り値
関数が成功した場合、戻り値はNO_ERROR。
関数が失敗した場合は、 FormatMessage を使用して、返されたエラーのメッセージ文字列を取得します。
注釈
アダプターが完全に無効になるまで、 GetAdapterIndex 関数はアダプターを存在として報告します。 たとえば、 NotifyAddrChange 関数は、最近無効になったアダプターの IP アドレスが削除されたことを示している可能性がありますが、 GetAdapterIndex はアダプターを無効にするプロセスが完了するまでアダプター インデックスを報告し続けます。
1 つ以上のアダプターがシステム上に存在する場合、 GetAdapterIndex は、クエリ対象のアダプターが存在しない場合にERROR_DEV_NOT_EXISTを返します。 アダプターが存在しない場合、 GetAdapterIndex 関数はERROR_NO_DATAを返します。
アダプターのインデックスは、アダプターを無効にしてから有効にした場合、またはその他の状況で変更される可能性があり、永続的と見なすべきではありません。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | iphlpapi.h |
| Library | Iphlpapi.lib |
| [DLL] | Iphlpapi.dll |