ホーム › Networking.WinSock › RtlEthernetStringToAddressW

RtlEthernetStringToAddressW

関数

文字列をイーサネットMACアドレスへ変換する。

DLLntdll.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 7 以降

シグネチャ

// ntdll.dll  (Unicode / -W)
#include <windows.h>

INT RtlEthernetStringToAddressW(
    LPCWSTR S,
    LPCWSTR* Terminator,
    DL_EUI48* Addr
);

パラメーター

名前	型	方向	説明
S	LPCWSTR	in	Ethernet MAC アドレスの NULL 終端文字列表現を格納したバッファーへのポインター。
Terminator	LPCWSTR*	out	変換された文字列を終端した文字へのポインターを受け取るパラメーター。呼び出し元はこれを利用して、文字列から追加情報を抽出できます。
Addr	DL_EUI48*	out	Ethernet MAC アドレスのバイナリ表現を格納する場所へのポインター。

戻り値の型: INT

公式ドキュメント

Ethernet MAC アドレスの文字列表現を、Ethernet アドレスのバイナリ形式に変換します。(Unicode)

戻り値

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

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

戻り値	説明
STATUS_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。このエラーは、S パラメーターが指す文字列が Ethernet MAC アドレスの適切な文字列表現を含んでいない場合に返されます。このエラーコードは Ntstatus.h ヘッダーファイルで定義されています。
その他	返されたエラーのメッセージ文字列を取得するには、 FormatMessage を使用してください。

解説(Remarks)

RtlEthernetStringToAddress 関数は、Ethernet EUI-48 データリンク層アドレス(一般に MAC アドレスとも呼ばれます)の文字列表現を、Ethernet アドレスのバイナリ形式に変換するために使用します。この文字列は、非 DIX 標準の "-" 表記で表された数値の Ethernet アドレスを表します。返される値は、Ethernet アドレスとして使用するのに適した数値です。すべての Ethernet アドレスはネットワークオーダー(バイトが左から右へ並ぶ順序)で返されます。

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

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

RtlEthernetStringToAddress は便宜的な関数であり、文字列から Ethernet アドレスへの変換を行うために Windows Sockets で提供される関数へアクセスする際に、Windows Sockets 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 を定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不整合が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規約を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// ntdll.dll  (Unicode / -W)
#include <windows.h>

INT RtlEthernetStringToAddressW(
    LPCWSTR S,
    LPCWSTR* Terminator,
    DL_EUI48* Addr
);

[DllImport("ntdll.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int RtlEthernetStringToAddressW(
    [MarshalAs(UnmanagedType.LPWStr)] string S,   // LPCWSTR
    IntPtr Terminator,   // LPCWSTR* out
    IntPtr Addr   // DL_EUI48* out
);

<DllImport("ntdll.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function RtlEthernetStringToAddressW(
    <MarshalAs(UnmanagedType.LPWStr)> S As String,   ' LPCWSTR
    Terminator As IntPtr,   ' LPCWSTR* out
    Addr As IntPtr   ' DL_EUI48* out
) As Integer
End Function

' S : LPCWSTR
' Terminator : LPCWSTR* out
' Addr : DL_EUI48* out
Declare PtrSafe Function RtlEthernetStringToAddressW Lib "ntdll" ( _
    ByVal S As LongPtr, _
    ByVal Terminator As LongPtr, _
    ByVal Addr As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RtlEthernetStringToAddressW = ctypes.windll.ntdll.RtlEthernetStringToAddressW
RtlEthernetStringToAddressW.restype = ctypes.c_int
RtlEthernetStringToAddressW.argtypes = [
    wintypes.LPCWSTR,  # S : LPCWSTR
    ctypes.c_void_p,  # Terminator : LPCWSTR* out
    ctypes.c_void_p,  # Addr : DL_EUI48* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ntdll.dll')
RtlEthernetStringToAddressW = Fiddle::Function.new(
  lib['RtlEthernetStringToAddressW'],
  [
    Fiddle::TYPE_VOIDP,  # S : LPCWSTR
    Fiddle::TYPE_VOIDP,  # Terminator : LPCWSTR* out
    Fiddle::TYPE_VOIDP,  # Addr : DL_EUI48* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "ntdll")]
extern "system" {
    fn RtlEthernetStringToAddressW(
        S: *const u16,  // LPCWSTR
        Terminator: *const *const u16,  // LPCWSTR* out
        Addr: *mut DL_EUI48  // DL_EUI48* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ntdll.dll", CharSet = CharSet.Unicode)]
public static extern int RtlEthernetStringToAddressW([MarshalAs(UnmanagedType.LPWStr)] string S, IntPtr Terminator, IntPtr Addr);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ntdll_RtlEthernetStringToAddressW' -Namespace Win32 -PassThru
# $api::RtlEthernetStringToAddressW(S, Terminator, Addr)

#uselib "ntdll.dll"
#func global RtlEthernetStringToAddressW "RtlEthernetStringToAddressW" wptr, wptr, wptr
; RtlEthernetStringToAddressW S, varptr(Terminator), varptr(Addr)   ; 戻り値は stat
; S : LPCWSTR -> "wptr"
; Terminator : LPCWSTR* out -> "wptr"
; Addr : DL_EUI48* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ntdll.dll"
#cfunc global RtlEthernetStringToAddressW "RtlEthernetStringToAddressW" wstr, var, var
; res = RtlEthernetStringToAddressW(S, Terminator, Addr)
; S : LPCWSTR -> "wstr"
; Terminator : LPCWSTR* out -> "var"
; Addr : DL_EUI48* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ntdll.dll"
#cfunc global RtlEthernetStringToAddressW "RtlEthernetStringToAddressW" wstr, sptr, sptr
; res = RtlEthernetStringToAddressW(S, varptr(Terminator), varptr(Addr))
; S : LPCWSTR -> "wstr"
; Terminator : LPCWSTR* out -> "sptr"
; Addr : DL_EUI48* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。