Win32 API 日本語リファレンス
ホームNetworking.WinSock › RtlEthernetStringToAddressA

RtlEthernetStringToAddressA

関数
文字列をイーサネットMACアドレスへ変換する。
DLLntdll.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 7 以降

シグネチャ

// ntdll.dll  (ANSI / -A)
#include <windows.h>

INT RtlEthernetStringToAddressA(
    LPCSTR S,
    LPCSTR* Terminator,
    DL_EUI48* Addr
);

パラメーター

名前方向説明
SLPCSTRinEthernet MAC アドレスの NULL 終端文字列表現を格納したバッファーへのポインター。
TerminatorLPCSTR*out変換された文字列を終端した文字へのポインターを受け取るパラメーター。呼び出し元はこれを使用して、文字列からさらに情報を取り出すことができます。
AddrDL_EUI48*outEthernet MAC アドレスのバイナリ表現を格納する場所へのポインター。

戻り値の型: INT

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は 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  (ANSI / -A)
#include <windows.h>

INT RtlEthernetStringToAddressA(
    LPCSTR S,
    LPCSTR* Terminator,
    DL_EUI48* Addr
);
[DllImport("ntdll.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int RtlEthernetStringToAddressA(
    [MarshalAs(UnmanagedType.LPStr)] string S,   // LPCSTR
    IntPtr Terminator,   // LPCSTR* out
    IntPtr Addr   // DL_EUI48* out
);
<DllImport("ntdll.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RtlEthernetStringToAddressA(
    <MarshalAs(UnmanagedType.LPStr)> S As String,   ' LPCSTR
    Terminator As IntPtr,   ' LPCSTR* out
    Addr As IntPtr   ' DL_EUI48* out
) As Integer
End Function
' S : LPCSTR
' Terminator : LPCSTR* out
' Addr : DL_EUI48* out
Declare PtrSafe Function RtlEthernetStringToAddressA Lib "ntdll" ( _
    ByVal S As String, _
    ByVal Terminator As LongPtr, _
    ByVal Addr As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RtlEthernetStringToAddressA = ctypes.windll.ntdll.RtlEthernetStringToAddressA
RtlEthernetStringToAddressA.restype = ctypes.c_int
RtlEthernetStringToAddressA.argtypes = [
    wintypes.LPCSTR,  # S : LPCSTR
    ctypes.c_void_p,  # Terminator : LPCSTR* out
    ctypes.c_void_p,  # Addr : DL_EUI48* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ntdll.dll')
RtlEthernetStringToAddressA = Fiddle::Function.new(
  lib['RtlEthernetStringToAddressA'],
  [
    Fiddle::TYPE_VOIDP,  # S : LPCSTR
    Fiddle::TYPE_VOIDP,  # Terminator : LPCSTR* out
    Fiddle::TYPE_VOIDP,  # Addr : DL_EUI48* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "ntdll")]
extern "system" {
    fn RtlEthernetStringToAddressA(
        S: *const u8,  // LPCSTR
        Terminator: *const *const u8,  // LPCSTR* 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.Ansi)]
public static extern int RtlEthernetStringToAddressA([MarshalAs(UnmanagedType.LPStr)] string S, IntPtr Terminator, IntPtr Addr);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ntdll_RtlEthernetStringToAddressA' -Namespace Win32 -PassThru
# $api::RtlEthernetStringToAddressA(S, Terminator, Addr)
#uselib "ntdll.dll"
#func global RtlEthernetStringToAddressA "RtlEthernetStringToAddressA" sptr, sptr, sptr
; RtlEthernetStringToAddressA S, varptr(Terminator), varptr(Addr)   ; 戻り値は stat
; S : LPCSTR -> "sptr"
; Terminator : LPCSTR* out -> "sptr"
; Addr : DL_EUI48* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ntdll.dll"
#cfunc global RtlEthernetStringToAddressA "RtlEthernetStringToAddressA" str, var, var
; res = RtlEthernetStringToAddressA(S, Terminator, Addr)
; S : LPCSTR -> "str"
; Terminator : LPCSTR* out -> "var"
; Addr : DL_EUI48* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT RtlEthernetStringToAddressA(LPCSTR S, LPCSTR* Terminator, DL_EUI48* Addr)
#uselib "ntdll.dll"
#cfunc global RtlEthernetStringToAddressA "RtlEthernetStringToAddressA" str, var, var
; res = RtlEthernetStringToAddressA(S, Terminator, Addr)
; S : LPCSTR -> "str"
; Terminator : LPCSTR* out -> "var"
; Addr : DL_EUI48* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ntdll = windows.NewLazySystemDLL("ntdll.dll")
	procRtlEthernetStringToAddressA = ntdll.NewProc("RtlEthernetStringToAddressA")
)

// S (LPCSTR), Terminator (LPCSTR* out), Addr (DL_EUI48* out)
r1, _, err := procRtlEthernetStringToAddressA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(S))),
	uintptr(Terminator),
	uintptr(Addr),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function RtlEthernetStringToAddressA(
  S: PAnsiChar;   // LPCSTR
  Terminator: PPAnsiChar;   // LPCSTR* out
  Addr: Pointer   // DL_EUI48* out
): Integer; stdcall;
  external 'ntdll.dll' name 'RtlEthernetStringToAddressA';
result := DllCall("ntdll\RtlEthernetStringToAddressA"
    , "AStr", S   ; LPCSTR
    , "Ptr", Terminator   ; LPCSTR* out
    , "Ptr", Addr   ; DL_EUI48* out
    , "Int")   ; return: INT
●RtlEthernetStringToAddressA(S, Terminator, Addr) = DLL("ntdll.dll", "int RtlEthernetStringToAddressA(char*, void*, void*)")
# 呼び出し: RtlEthernetStringToAddressA(S, Terminator, Addr)
# S : LPCSTR -> "char*"
# Terminator : LPCSTR* out -> "void*"
# Addr : DL_EUI48* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "ntdll" fn RtlEthernetStringToAddressA(
    S: [*c]const u8, // LPCSTR
    Terminator: [*c][*c]u8, // LPCSTR* out
    Addr: [*c]DL_EUI48 // DL_EUI48* out
) callconv(std.os.windows.WINAPI) i32;
proc RtlEthernetStringToAddressA(
    S: cstring,  # LPCSTR
    Terminator: ptr cstring,  # LPCSTR* out
    Addr: ptr DL_EUI48  # DL_EUI48* out
): int32 {.importc: "RtlEthernetStringToAddressA", stdcall, dynlib: "ntdll.dll".}
pragma(lib, "ntdll");
extern(Windows)
int RtlEthernetStringToAddressA(
    const(char)* S,   // LPCSTR
    char** Terminator,   // LPCSTR* out
    DL_EUI48* Addr   // DL_EUI48* out
);
ccall((:RtlEthernetStringToAddressA, "ntdll.dll"), stdcall, Int32,
      (Cstring, Ptr{Ptr{UInt8}}, Ptr{DL_EUI48}),
      S, Terminator, Addr)
# S : LPCSTR -> Cstring
# Terminator : LPCSTR* out -> Ptr{Ptr{UInt8}}
# Addr : DL_EUI48* out -> Ptr{DL_EUI48}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t RtlEthernetStringToAddressA(
    const char* S,
    char** Terminator,
    void* Addr);
]]
local ntdll = ffi.load("ntdll")
-- ntdll.RtlEthernetStringToAddressA(S, Terminator, Addr)
-- S : LPCSTR
-- Terminator : LPCSTR* out
-- Addr : DL_EUI48* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ntdll.dll');
const RtlEthernetStringToAddressA = lib.func('__stdcall', 'RtlEthernetStringToAddressA', 'int32_t', ['str', 'void *', 'void *']);
// RtlEthernetStringToAddressA(S, Terminator, Addr)
// S : LPCSTR -> 'str'
// Terminator : LPCSTR* out -> 'void *'
// Addr : DL_EUI48* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ntdll.dll", {
  RtlEthernetStringToAddressA: { parameters: ["buffer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.RtlEthernetStringToAddressA(S, Terminator, Addr)
// S : LPCSTR -> "buffer"
// Terminator : LPCSTR* out -> "pointer"
// Addr : DL_EUI48* out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t RtlEthernetStringToAddressA(
    const char* S,
    char** Terminator,
    void* Addr);
C, "ntdll.dll");
// $ffi->RtlEthernetStringToAddressA(S, Terminator, Addr);
// S : LPCSTR
// Terminator : LPCSTR* out
// Addr : DL_EUI48* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Ntdll extends StdCallLibrary {
    Ntdll INSTANCE = Native.load("ntdll", Ntdll.class, W32APIOptions.ASCII_OPTIONS);
    int RtlEthernetStringToAddressA(
        String S,   // LPCSTR
        PointerByReference Terminator,   // LPCSTR* out
        Pointer Addr   // DL_EUI48* out
    );
}
@[Link("ntdll")]
lib Libntdll
  fun RtlEthernetStringToAddressA = RtlEthernetStringToAddressA(
    S : UInt8*,   # LPCSTR
    Terminator : UInt8**,   # LPCSTR* out
    Addr : DL_EUI48*   # DL_EUI48* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef RtlEthernetStringToAddressANative = Int32 Function(Pointer<Utf8>, Pointer<Pointer<Utf8>>, Pointer<Void>);
typedef RtlEthernetStringToAddressADart = int Function(Pointer<Utf8>, Pointer<Pointer<Utf8>>, Pointer<Void>);
final RtlEthernetStringToAddressA = DynamicLibrary.open('ntdll.dll')
    .lookupFunction<RtlEthernetStringToAddressANative, RtlEthernetStringToAddressADart>('RtlEthernetStringToAddressA');
// S : LPCSTR -> Pointer<Utf8>
// Terminator : LPCSTR* out -> Pointer<Pointer<Utf8>>
// Addr : DL_EUI48* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RtlEthernetStringToAddressA(
  S: PAnsiChar;   // LPCSTR
  Terminator: PPAnsiChar;   // LPCSTR* out
  Addr: Pointer   // DL_EUI48* out
): Integer; stdcall;
  external 'ntdll.dll' name 'RtlEthernetStringToAddressA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RtlEthernetStringToAddressA"
  c_RtlEthernetStringToAddressA :: CString -> Ptr CString -> Ptr () -> IO Int32
-- S : LPCSTR -> CString
-- Terminator : LPCSTR* out -> Ptr CString
-- Addr : DL_EUI48* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rtlethernetstringtoaddressa =
  foreign "RtlEthernetStringToAddressA"
    (string @-> (ptr string) @-> (ptr void) @-> returning int32_t)
(* S : LPCSTR -> string *)
(* Terminator : LPCSTR* out -> (ptr string) *)
(* Addr : DL_EUI48* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ntdll (t "ntdll.dll"))
(cffi:use-foreign-library ntdll)

(cffi:defcfun ("RtlEthernetStringToAddressA" rtl-ethernet-string-to-address-a :convention :stdcall) :int32
  (s :string)   ; LPCSTR
  (terminator :pointer)   ; LPCSTR* out
  (addr :pointer))   ; DL_EUI48* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RtlEthernetStringToAddressA = Win32::API::More->new('ntdll',
    'int RtlEthernetStringToAddressA(LPCSTR S, LPVOID Terminator, LPVOID Addr)');
# my $ret = $RtlEthernetStringToAddressA->Call($S, $Terminator, $Addr);
# S : LPCSTR -> LPCSTR
# Terminator : LPCSTR* out -> LPVOID
# Addr : DL_EUI48* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目
使用する型