ConvertInterfaceLuidToNameA 関数 (netioapi.h)
ConvertInterfaceLuidToNameA 関数は、ネットワーク インターフェイスのローカル一意識別子 (LUID) を ANSI インターフェイス名に変換します。
構文
IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API ConvertInterfaceLuidToNameA(
[in] const NET_LUID *InterfaceLuid,
[out] PSTR InterfaceName,
[in] SIZE_T Length
);
パラメーター
[in] InterfaceLuid
ネットワーク インターフェイスの NET_LUID へのポインター。
[out] InterfaceName
関数が正常に返されたときに、インターフェイス名を含む NULL で終わる ANSI 文字列を保持するバッファーへのポインター。
[in] Length
InterfaceName パラメーターが指すバッファーの長さ (バイト単位)。 この値は、インターフェイス名と終端の null 文字に対応できる十分な大きさにする必要があります。 必要な最大長は NDIS_IF_MAX_STRING_SIZE + 1 です。
戻り値
成功すると、 ConvertInterfaceLuidToNameA は NETIO_ERROR_SUCCESSを返します。 0 以外の戻り値は、エラーを示します。
エラー コード | 意味 |
---|---|
|
1 つのパラメーターが無効です。 このエラーは、 InterfaceLuid パラメーターまたは InterfaceName パラメーターが NULL の場合、または InterfaceLuid パラメーターが無効な場合に返されます。 |
|
このコマンドを処理するのに十分なストレージがありません。 このエラーは、 InterfaceName パラメーターが指すバッファーのサイズが、インターフェイス名を保持するために Length パラメーターで指定された十分な大きさではなかった場合に返されます。 |
注釈
ConvertInterfaceLuidToNameA 関数は、Windows Vista 以降で使用できます。
ConvertInterfaceLuidToNameA 関数はプロトコルに依存せず、IPv6 プロトコルと IPv4 プロトコルの両方のネットワーク インターフェイスで動作します。 ConvertInterfaceLuidToNameA は、ネットワーク インターフェイス LUID を ANSI インターフェイス名に変換します。
ConvertInterfaceLuidToNameW は、ネットワーク インターフェイス LUID を Unicode インターフェイス名に変換します。
インターフェイス名の最大長 (NDIS_IF_MAX_STRING_SIZE、終了 NULL なし) は、 Ntddndis.h ヘッダー ファイルで宣言されます。 NDIS_IF_MAX_STRING_SIZEは、Ifdef.h ヘッダー ファイルで定義されているIF_MAX_STRING_SIZE定数として定義されます。 Ntddndis.h ヘッダー ファイルと Ifdef.h ヘッダー ファイルは、Iphlpapi.h ヘッダー ファイルによって自動的に含まれる Netioapi.h ヘッダー ファイルに自動的に含まれます。 Ntddndis.h、Ifdef.h、および Netioapi.h ヘッダー ファイルを直接使用しないでください。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
サポートされている最小のサーバー | Windows Server 2008 [デスクトップ アプリのみ] |
対象プラットフォーム | Windows |
ヘッダー | netioapi.h (Iphlpapi.h を含む) |
Library | Iphlpapi.lib |
[DLL] | Iphlpapi.dll |