ConvertInterfaceNameToLuidA 関数 (netioapi.h)

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

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

構文

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API ConvertInterfaceNameToLuidA(
  [in]  const CHAR *InterfaceName,
  [out] NET_LUID   *InterfaceLuid
);

パラメーター

[in] InterfaceName

ネットワークインターフェイス名を含む NULL で終わる ANSI 文字列へのポインター。

[out] InterfaceLuid

このインターフェイスの NET_LUID へのポインター。

戻り値

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

エラーコード	意味
ERROR_BUFFER_OVERFLOW	ANSI インターフェイス名の長さが無効です。 InterfaceName パラメーターがこのパラメーターで許容される最大文字列長を超えた場合、このエラーが返されます。
ERROR_INVALID_NAME	インターフェイス名が無効です。 InterfaceName パラメーターに無効な名前が含まれている場合、このエラーが返されます。
ERROR_INVALID_PARAMETER	1 つのパラメーターが無効です。 InterfaceLuid パラメーターが NULL の場合、このエラーが返されます。

注釈

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

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

ConvertInterfaceNameToLuidW は、Unicode インターフェイス名を LUID に変換します。

インターフェイス名の最大長 (終端の NULL を除くNDIS_IF_MAX_STRING_SIZE) は、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