ConvertInterfaceLuidToAlias 関数 (netioapi.h)

[アーティクル]
08/25/2023

ConvertInterfaceLuidToAlias 関数は、ネットワークインターフェイスのローカル一意識別子 (LUID) をインターフェイスエイリアスに変換します。

構文

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API ConvertInterfaceLuidToAlias(
  [in]  const NET_LUID *InterfaceLuid,
  [out] PWSTR          InterfaceAlias,
  [in]  SIZE_T         Length
);

パラメーター

[in] InterfaceLuid

ネットワークインターフェイスの NET_LUID へのポインター。

[out] InterfaceAlias

関数が正常に返されたときに、ネットワークインターフェイスのエイリアス名を含む NULL で終わる Unicode 文字列を保持するバッファーへのポインター。

[in] Length

InterfaceAlias パラメーターが指すバッファーの長さ (文字数)。この値は、ネットワークインターフェイスのエイリアス名と終端の NULL 文字に対応できる十分な大きさにする必要があります。必要な最大長は NDIS_IF_MAX_STRING_SIZE + 1 です。

戻り値

成功すると、 ConvertInterfaceLuidToAlias は NO_ERRORを返します。 0 以外の戻り値は、エラーを示します。

エラーコード	意味
ERROR_INVALID_PARAMETER	1 つのパラメーターが無効です。このエラーは、 InterfaceLuid パラメーターまたは InterfaceAlias パラメーターが NULL の場合、または InterfaceLuid パラメーターが無効な場合に返されます。
ERROR_NOT_ENOUGH_MEMORY	このコマンドを処理するのに十分なストレージがありません。このエラーは、 InterfaceAlias パラメーターが指すバッファーのサイズが、エイリアス名を保持するために Length パラメーターで指定されている十分な大きさではなかった場合に返されます。

注釈

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

ConvertInterfaceLuidToAlias 関数はプロトコルに依存せず、IPv6 プロトコルと IPv4 プロトコルの両方のネットワークインターフェイスで動作します。

ネットワークインターフェイスのエイリアス名の最大長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