RtlEthernetStringToAddressA 関数 (ip2string.h)

  • [アーティクル]

RtlEthernetStringToAddress 関数は、イーサネット MAC アドレスの文字列表現をイーサネット アドレスのバイナリ形式に変換します。

構文

NTSYSAPI NTSTATUS RtlEthernetStringToAddressA(
  [in]  PCSTR    S,
  [out] PCSTR    *Terminator,
  [out] DL_EUI48 *Addr
);

パラメーター

[in] S

イーサネット MAC アドレスの NULL で終わる文字列表現を含むバッファーへのポインター。

[out] Terminator

変換された文字列を終了した文字へのポインターを受け取るパラメーター。 これは、呼び出し元が文字列から詳細情報を抽出するために使用できます。

[out] Addr

イーサネット MAC アドレスのバイナリ表現を格納するポインター。

戻り値

関数が成功した場合、戻り値は STATUS_SUCCESS。

関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。

リターン コード 説明
STATUS_INVALID_PARAMETER
 無効なパラメーターが関数に渡されました。 このエラーは、 S パラメーターが指す文字列にイーサネット MAC アドレスの適切な文字列表現が含まれていない場合に返されます。

このエラー コードは Ntstatus.h ヘッダー ファイルで定義されています。
その他
 FormatMessage を使用して、返されたエラーのメッセージ文字列を取得します。

注釈

RtlEthernetStringToAddress 関数は、イーサネット EUI-48 データ リンク レイヤー アドレス (通常は MAC アドレスとも呼ばれます) の文字列形式をイーサネット アドレスのバイナリ形式に変換するために使用されます。 文字列は、DIX 以外の標準の "-'' 表記で表される数値イーサネット アドレスを表します。 返される値は、イーサネット アドレスとして使用するのに適した数値です。 すべてのイーサネット アドレスは、ネットワーク順 (左から右に並べ替えられたバイト数) で返されます。

S パラメーターが指す文字列は、非 DIX 標準の "-" 表記でイーサネット MAC アドレス文字列の形式で表す必要があります。 イーサネット MAC アドレスの基本的な文字列表現は、ダッシュで区切られた 6 組の 16 進数 (F4-CE-46-2D-90-8C など) で構成されます。

成功した場合、 Terminator パラメーターは、変換された文字列を終了した文字を指します。 これにより、アプリケーションは、イーサネット アドレスと追加情報を含む文字列を RtlEthernetStringToAddress 関数に渡し、残りの情報を解析できます。

RtlEthernetStringToAddress は、Windows ソケットで提供される関数にアクセスして、文字列からイーサネット アドレスへの変換を実行するために Windows ソケット DLL を読み込む必要がない便利な関数です。

UNICODE または_UNICODEが定義されている場合、 RtlEthernetStringToAddress は、この関数の Unicode バージョンである RtlEthernetStringToAddressW に定義されます。 S パラメーターと Terminator パラメーターは、PCWSTR データ型に対して定義されます。

UNICODE と_UNICODEの両方が定義されていない場合、 RtlEthernetStringToAddress は、この関数の ANSI バージョンである RtlEthernetStringToAddressA に定義されます。 S パラメーターと Terminator パラメーターは、PCSTR データ型に対して定義されます。

DL_EUI48データ型は、Mstcpip.h ヘッダー ファイルで定義されています。

注意

ip2string.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして RtlEthernetStringToAddress を定義します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows 7 [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー Windows Server 2008 R2 [デスクトップ アプリ |UWP アプリ]
対象プラットフォーム Windows
ヘッダー ip2string.h (Mstcpip.h、Ip2string.h を含む)
Library ntdll.lib
[DLL] ntdll.dll

こちらもご覧ください

RtlEthernetAddressToString