ConvertInterfaceLuidToAlias 関数
ConvertInterfaceLuidToAlias 関数は、ネットワーク インターフェイスのローカル一意識別子 (LUID) をインターフェイス エイリアスに変換します。
Note
ConvertInterfaceXxx API ファミリは、TCP/IP にバインドされているすべてのインターフェイスの識別子を列挙します。これには、仮想ミニポート、軽量フィルター、トンネル アダプター、物理インターフェイスが含まれる場合があります。
構文
NETIOAPI_API ConvertInterfaceLuidToAlias(
_In_ const NET_LUID *InterfaceLuid,
_Out_ PWSTR InterfaceAlias,
_In_ SIZE_T Length
);
パラメーター
InterfaceLuid [in]
ネットワーク インターフェイスの NET_LUID 共用体へのポインター。InterfaceAlias [out]
NULL で終わる Unicode 文字列を保持するバッファーへのポインター。 ConvertInterfaceLuidToAlias が正常に返された場合、InterfaceAlias にはネットワーク インターフェイスのエイリアス名が含まれます。Length [in]
InterfaceAlias パラメーターが 指すバッファーの長さ (文字数単位)。 この値は、ネットワーク・インターフェースの別名と終端の NULL 文字を保持するのに十分な大きさでなければなりません。 最大許容長は NDIS_IF_MAX_STRING_SIZE + 1 です。 NDIS_IF_MAX_STRING_SIZEの詳細については、次の「解説」セクションを参照してください。
戻り値
ConvertInterfaceLuidToAlias は、関数が成功した場合に STATUS_SUCCESS を返します。 関数が失敗した場合、ConvertInterfaceLuidToAlias は次のいずれかのエラー コードを返します。
| リターン コード | 説明 |
|---|---|
| STATUS_INVALID_PARAMETER | パラメーターの 1 つが無効です。 ConvertInterfaceLuidToAlias は、InterfaceLuid または InterfaceAlias が NULL の場合、または InterfaceLuid が無効な場合に、このエラーを返します。 |
| STATUS_NOT_ENOUGH_MEMORY | 使用可能なストレージが足りません。 ConvertInterfaceLuidToAlias は、InterfaceAlias パラメーターが指すバッファーのサイズが Length パラメーターで指定された大きさではなかったため、バッファーがエイリアス名を保持できなかった場合に、このエラーを返します。 |
解説
ConvertInterfaceLuidToAlias 関数はプロトコルに依存せず、IPv6 プロトコルと IPv4 プロトコルの両方のネットワーク インターフェイスで動作します。
ネットワーク インターフェイスのエイリアス名の最大長 NDIS_IF_MAX_STRING_SIZE (終端の NULL 文字を除く) は、 Ntddndis.h ヘッダー ファイルで宣言されます。 NDIS_IF_MAX_STRING_SIZE は、Ifdef.h ヘッダー ファイルで定義されているIF_MAX_STRING_SIZE定数として定義されます。
Note
Ntddndis.h および Ifdef.h ヘッダー ファイルは、 Netioapi.h ヘッダー ファイルに自動的に含まれます。 Ntddndis.h ヘッダー ファイルと Ifdef.h ヘッダー ファイルを直接使用しないでください。
要件
対象プラットフォーム |
ユニバーサル |
バージョン |
Windows Vista 以降のバージョンの Windows オペレーティング システムで使用できます。 |
ヘッダー |
Netioapi.h (Netioapi.h を含む) |
ライブラリ |
Netio.lib |
IRQL |
PASSIVE_LEVEL |