次の方法で共有


ConvertInterfaceNameToLuidA 関数

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

Note

ConvertInterfaceXxx API ファミリは、TCP/IP にバインドされているすべてのインターフェイスの識別子を列挙します。これには、仮想ミニポート、軽量フィルター、トンネル アダプター、物理インターフェイスが含まれる場合があります。

構文

NETIOAPI_API ConvertInterfaceNameToLuidA(
  _In_  const CHAR     *InterfaceName,
  _Out_       NET_LUID *InterfaceLuid
);

パラメーター

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

  • InterfaceLuid [out]
    このインターフェイスの NET_LUID 共用体へのポインター。

戻り値

ConvertInterfaceNameToLuidA は、関数が成功した場合に STATUS_SUCCESS を返します。 関数が失敗した場合、ConvertInterfaceNameToLuidA は次のいずれかのエラー コードを返します。

リターン コード 説明
ERROR_BUFFER_OVERFLOW

ANSI インタフェース名の長さが無効です。 ConvertInterfaceNameToLuidA は、InterfaceName パラメーターがこのパラメーターで許容される文字列の最大長を超えた場合に、このエラーを返します。

STATUS_INVALID_NAME

インターフェイス名が無効です。 ConvertInterfaceNameToLuidA は、InterfaceName パラメーターに無効なインターフェイス名が含まれている場合、このエラーを返します。

STATUS_INVALID_PARAMETER

パラメーターの 1 つが無効です。 InterfaceLuid パラメーターが NULL の場合、ConvertInterfaceNameToLuidA はこのエラーを返します。

解説

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

終端の NULLを除いたネットワーク インターフェイス名の最大長 NDIS_IF_MAX_STRING_SIZE は、Ntddndis.h ヘッダー ファイルで定義されています。 NDIS_IF_MAX_STRING_SIZE は、Ifdef.h ヘッダー ファイルで定義されている IF_MAX_STRING_SIZE 定数として定義されます。

Note

Ntddndis.h および Ifdef.h ヘッダー ファイルは、 Netioapi.h ヘッダー ファイルに自動的に含まれます。 Ntddndis.h ヘッダー ファイルと Ifdef.h ヘッダー ファイルを直接使用しないでください。

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

要件

対象プラットフォーム

ユニバーサル

バージョン

Windows Vista 以降のバージョンの Windows オペレーティング システムで使用できます。

ヘッダー

Netioapi.h (Netioapi.h を含む)

ライブラリ

Netio.lib

IRQL

PASSIVE_LEVEL

関連項目

ConvertInterfaceAliasToLuid

ConvertInterfaceGuidToLuid

ConvertInterfaceIndexToLuid

ConvertInterfaceLuidToAlias

ConvertInterfaceLuidToGuid

ConvertInterfaceLuidToIndex

ConvertInterfaceLuidToNameA

ConvertInterfaceLuidToNameW

ConvertInterfaceNameToLuidW

NET_LUID