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

RtlEthernetAddressToStringW

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

シグネチャ

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

LPWSTR RtlEthernetAddressToStringW(
    const DL_EUI48* Addr,
    LPWSTR S
);

パラメーター

名前方向説明
AddrDL_EUI48*inバイナリ形式の Ethernet アドレス。Ethernet アドレスはネットワークオーダー(バイトが左から右へ並ぶ順序)で指定します。
SLPWSTRoutEthernet アドレスの NULL 終端文字列表現を格納するバッファーへのポインター。このバッファーは少なくとも 18 文字を保持できる大きさである必要があります。

戻り値の型: LPWSTR

公式ドキュメント

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

戻り値

Ethernet MAC アドレスの文字列表現の末尾に挿入された NULL 文字へのポインター。 呼び出し元はこれを利用して、文字列にさらに情報を簡単に追加できます。

解説(Remarks)

RtlEthernetAddressToString 関数は、バイナリ形式の Ethernet アドレスを、Ethernet EUI-48 データリンク層アドレス形式(一般に MAC アドレスとも呼ばれます)の文字列表現に変換するために使用します。この文字列は、非 DIX 標準の "-'' 表記で表現された数値形式の Ethernet アドレスを表します。

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

RtlEthernetAddressToString は便宜的な関数であり、文字列から Ethernet アドレスへの変換を実行するために Windows Sockets が提供する関数へアクセスするのに、Windows Sockets DLL を読み込む必要はありません。

UNICODE または _UNICODE のいずれかが定義されている場合、RtlEthernetAddressToString はこの関数の Unicode 版である RtlEthernetAddressToStringW として定義されます。文字列パラメーター S と関数の戻り値は PWSTR データ型として定義されます。

UNICODE と _UNICODE のいずれも定義されていない場合、RtlEthernetAddressToString はこの関数の ANSI 版である RtlEthernetAddressToStringA として定義されます。文字列パラメーター S と関数の戻り値は PSTR データ型として定義されます。

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

メモ

ip2string.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして RtlEthernetAddressToString を定義します。このエンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在して使用すると、不一致が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

LPWSTR RtlEthernetAddressToStringW(
    const DL_EUI48* Addr,
    LPWSTR S
);
[DllImport("ntdll.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern IntPtr RtlEthernetAddressToStringW(
    IntPtr Addr,   // DL_EUI48*
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder S   // LPWSTR out
);
<DllImport("ntdll.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function RtlEthernetAddressToStringW(
    Addr As IntPtr,   ' DL_EUI48*
    <MarshalAs(UnmanagedType.LPWStr)> S As System.Text.StringBuilder   ' LPWSTR out
) As IntPtr
End Function
' Addr : DL_EUI48*
' S : LPWSTR out
Declare PtrSafe Function RtlEthernetAddressToStringW Lib "ntdll" ( _
    ByVal Addr As LongPtr, _
    ByVal S As LongPtr) As LongPtr
' 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

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

lib = Fiddle.dlopen('ntdll.dll')
RtlEthernetAddressToStringW = Fiddle::Function.new(
  lib['RtlEthernetAddressToStringW'],
  [
    Fiddle::TYPE_VOIDP,  # Addr : DL_EUI48*
    Fiddle::TYPE_VOIDP,  # S : LPWSTR out
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "ntdll")]
extern "system" {
    fn RtlEthernetAddressToStringW(
        Addr: *const DL_EUI48,  // DL_EUI48*
        S: *mut u16  // LPWSTR out
    ) -> *mut u16;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ntdll.dll", CharSet = CharSet.Unicode)]
public static extern IntPtr RtlEthernetAddressToStringW(IntPtr Addr, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder S);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ntdll_RtlEthernetAddressToStringW' -Namespace Win32 -PassThru
# $api::RtlEthernetAddressToStringW(Addr, S)
#uselib "ntdll.dll"
#func global RtlEthernetAddressToStringW "RtlEthernetAddressToStringW" wptr, wptr
; RtlEthernetAddressToStringW varptr(Addr), varptr(S)   ; 戻り値は stat
; Addr : DL_EUI48* -> "wptr"
; S : LPWSTR out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ntdll.dll"
#cfunc global RtlEthernetAddressToStringW "RtlEthernetAddressToStringW" var, var
; res = RtlEthernetAddressToStringW(Addr, S)
; Addr : DL_EUI48* -> "var"
; S : LPWSTR out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; LPWSTR RtlEthernetAddressToStringW(DL_EUI48* Addr, LPWSTR S)
#uselib "ntdll.dll"
#cfunc global RtlEthernetAddressToStringW "RtlEthernetAddressToStringW" var, var
; res = RtlEthernetAddressToStringW(Addr, S)
; Addr : DL_EUI48* -> "var"
; S : LPWSTR out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ntdll = windows.NewLazySystemDLL("ntdll.dll")
	procRtlEthernetAddressToStringW = ntdll.NewProc("RtlEthernetAddressToStringW")
)

// Addr (DL_EUI48*), S (LPWSTR out)
r1, _, err := procRtlEthernetAddressToStringW.Call(
	uintptr(Addr),
	uintptr(S),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // LPWSTR
function RtlEthernetAddressToStringW(
  Addr: Pointer;   // DL_EUI48*
  S: PWideChar   // LPWSTR out
): PWideChar; stdcall;
  external 'ntdll.dll' name 'RtlEthernetAddressToStringW';
result := DllCall("ntdll\RtlEthernetAddressToStringW"
    , "Ptr", Addr   ; DL_EUI48*
    , "Ptr", S   ; LPWSTR out
    , "Ptr")   ; return: LPWSTR
●RtlEthernetAddressToStringW(Addr, S) = DLL("ntdll.dll", "char* RtlEthernetAddressToStringW(void*, char*)")
# 呼び出し: RtlEthernetAddressToStringW(Addr, S)
# Addr : DL_EUI48* -> "void*"
# S : LPWSTR out -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "ntdll" fn RtlEthernetAddressToStringW(
    Addr: [*c]DL_EUI48, // DL_EUI48*
    S: [*c]u16 // LPWSTR out
) callconv(std.os.windows.WINAPI) [*c]const u16;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc RtlEthernetAddressToStringW(
    Addr: ptr DL_EUI48,  # DL_EUI48*
    S: ptr uint16  # LPWSTR out
): WideCString {.importc: "RtlEthernetAddressToStringW", stdcall, dynlib: "ntdll.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "ntdll");
extern(Windows)
const(wchar)* RtlEthernetAddressToStringW(
    DL_EUI48* Addr,   // DL_EUI48*
    wchar* S   // LPWSTR out
);
ccall((:RtlEthernetAddressToStringW, "ntdll.dll"), stdcall, Cwstring,
      (Ptr{DL_EUI48}, Ptr{UInt16}),
      Addr, S)
# Addr : DL_EUI48* -> Ptr{DL_EUI48}
# S : LPWSTR out -> Ptr{UInt16}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
const uint16_t* RtlEthernetAddressToStringW(
    void* Addr,
    uint16_t* S);
]]
local ntdll = ffi.load("ntdll")
-- ntdll.RtlEthernetAddressToStringW(Addr, S)
-- Addr : DL_EUI48*
-- S : LPWSTR out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('ntdll.dll');
const RtlEthernetAddressToStringW = lib.func('__stdcall', 'RtlEthernetAddressToStringW', 'void *', ['void *', 'uint16_t *']);
// RtlEthernetAddressToStringW(Addr, S)
// Addr : DL_EUI48* -> 'void *'
// S : LPWSTR out -> 'uint16_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ntdll.dll", {
  RtlEthernetAddressToStringW: { parameters: ["pointer", "buffer"], result: "pointer" },
});
// lib.symbols.RtlEthernetAddressToStringW(Addr, S)
// Addr : DL_EUI48* -> "pointer"
// S : LPWSTR out -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
const uint16_t* RtlEthernetAddressToStringW(
    void* Addr,
    uint16_t* S);
C, "ntdll.dll");
// $ffi->RtlEthernetAddressToStringW(Addr, S);
// Addr : DL_EUI48*
// S : LPWSTR 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.UNICODE_OPTIONS);
    Pointer RtlEthernetAddressToStringW(
        Pointer Addr,   // DL_EUI48*
        char[] S   // LPWSTR out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("ntdll")]
lib Libntdll
  fun RtlEthernetAddressToStringW = RtlEthernetAddressToStringW(
    Addr : DL_EUI48*,   # DL_EUI48*
    S : UInt16*   # LPWSTR out
  ) : UInt16*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef RtlEthernetAddressToStringWNative = Pointer<Utf16> Function(Pointer<Void>, Pointer<Utf16>);
typedef RtlEthernetAddressToStringWDart = Pointer<Utf16> Function(Pointer<Void>, Pointer<Utf16>);
final RtlEthernetAddressToStringW = DynamicLibrary.open('ntdll.dll')
    .lookupFunction<RtlEthernetAddressToStringWNative, RtlEthernetAddressToStringWDart>('RtlEthernetAddressToStringW');
// Addr : DL_EUI48* -> Pointer<Void>
// S : LPWSTR out -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RtlEthernetAddressToStringW(
  Addr: Pointer;   // DL_EUI48*
  S: PWideChar   // LPWSTR out
): PWideChar; stdcall;
  external 'ntdll.dll' name 'RtlEthernetAddressToStringW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

(cffi:defcfun ("RtlEthernetAddressToStringW" rtl-ethernet-address-to-string-w :convention :stdcall) (:string :encoding :utf-16le)
  (addr :pointer)   ; DL_EUI48*
  (s :pointer))   ; LPWSTR out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RtlEthernetAddressToStringW = Win32::API::More->new('ntdll',
    'LPWSTR RtlEthernetAddressToStringW(LPVOID Addr, LPWSTR S)');
# my $ret = $RtlEthernetAddressToStringW->Call($Addr, $S);
# Addr : DL_EUI48* -> LPVOID
# S : LPWSTR out -> LPWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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