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

RtlIpv6AddressToStringW

関数
IPv6アドレスを文字列表現へ変換する。
DLLntdll.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

LPWSTR RtlIpv6AddressToStringW(
    const IN6_ADDR* Addr,
    LPWSTR S
);

パラメーター

名前方向説明
AddrIN6_ADDR*inネットワークバイトオーダーの IPv6 アドレス。
SLPWSTRoutIPv6 アドレスの NULL 終端文字列表現を格納するバッファへのポインター。このバッファは少なくとも 46 文字を保持できる十分な大きさである必要があります。

戻り値の型: LPWSTR

公式ドキュメント

IPv6 アドレスをインターネット標準形式の文字列に変換します。(Unicode)

戻り値

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

解説(Remarks)

RtlIpv6AddressToString 関数は、IPv6 アドレスをインターネット標準形式の IPv6 アドレス文字列表現に変換するために使用されます。

基本的な文字列表現は、コロンで区切られた 8 個の 16 進数で構成されます。連続するゼロの並びはダブルコロンに置き換えられます。 IPv6 アドレスの文字列表現に含めることができるダブルコロンは 1 つだけです。アドレスが IPv4 互換アドレス、IPv4 マップド IPv6 アドレス、または ISATAP アドレスである場合、末尾の 32 ビットは IPv4 スタイルのドット区切りオクテット表記で表されます。詳細については、IETF が公開している RFC 5942 のセクション 5 を参照してください。

RtlIpv6AddressToString は、IP アドレスから文字列への変換を行うために Windows Sockets で提供される関数にアクセスする際に、Windows Sockets DLL をロードする必要がない便利な関数です。

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

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

IN6_ADDR 構造体は In6addr.h ヘッダーファイルで定義されています。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 RtlIpv6AddressToStringW(
    const IN6_ADDR* Addr,
    LPWSTR S
);
[DllImport("ntdll.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern IntPtr RtlIpv6AddressToStringW(
    IntPtr Addr,   // IN6_ADDR*
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder S   // LPWSTR out
);
<DllImport("ntdll.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function RtlIpv6AddressToStringW(
    Addr As IntPtr,   ' IN6_ADDR*
    <MarshalAs(UnmanagedType.LPWStr)> S As System.Text.StringBuilder   ' LPWSTR out
) As IntPtr
End Function
' Addr : IN6_ADDR*
' S : LPWSTR out
Declare PtrSafe Function RtlIpv6AddressToStringW 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

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

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

var (
	ntdll = windows.NewLazySystemDLL("ntdll.dll")
	procRtlIpv6AddressToStringW = ntdll.NewProc("RtlIpv6AddressToStringW")
)

// Addr (IN6_ADDR*), S (LPWSTR out)
r1, _, err := procRtlIpv6AddressToStringW.Call(
	uintptr(Addr),
	uintptr(S),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // LPWSTR
function RtlIpv6AddressToStringW(
  Addr: Pointer;   // IN6_ADDR*
  S: PWideChar   // LPWSTR out
): PWideChar; stdcall;
  external 'ntdll.dll' name 'RtlIpv6AddressToStringW';
result := DllCall("ntdll\RtlIpv6AddressToStringW"
    , "Ptr", Addr   ; IN6_ADDR*
    , "Ptr", S   ; LPWSTR out
    , "Ptr")   ; return: LPWSTR
●RtlIpv6AddressToStringW(Addr, S) = DLL("ntdll.dll", "char* RtlIpv6AddressToStringW(void*, char*)")
# 呼び出し: RtlIpv6AddressToStringW(Addr, S)
# Addr : IN6_ADDR* -> "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 RtlIpv6AddressToStringW(
    Addr: [*c]IN6_ADDR, // IN6_ADDR*
    S: [*c]u16 // LPWSTR out
) callconv(std.os.windows.WINAPI) [*c]const u16;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc RtlIpv6AddressToStringW(
    Addr: ptr IN6_ADDR,  # IN6_ADDR*
    S: ptr uint16  # LPWSTR out
): WideCString {.importc: "RtlIpv6AddressToStringW", stdcall, dynlib: "ntdll.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "ntdll");
extern(Windows)
const(wchar)* RtlIpv6AddressToStringW(
    IN6_ADDR* Addr,   // IN6_ADDR*
    wchar* S   // LPWSTR out
);
ccall((:RtlIpv6AddressToStringW, "ntdll.dll"), stdcall, Cwstring,
      (Ptr{IN6_ADDR}, Ptr{UInt16}),
      Addr, S)
# Addr : IN6_ADDR* -> Ptr{IN6_ADDR}
# S : LPWSTR out -> Ptr{UInt16}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
const uint16_t* RtlIpv6AddressToStringW(
    void* Addr,
    uint16_t* S);
]]
local ntdll = ffi.load("ntdll")
-- ntdll.RtlIpv6AddressToStringW(Addr, S)
-- Addr : IN6_ADDR*
-- 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 RtlIpv6AddressToStringW = lib.func('__stdcall', 'RtlIpv6AddressToStringW', 'void *', ['void *', 'uint16_t *']);
// RtlIpv6AddressToStringW(Addr, S)
// Addr : IN6_ADDR* -> 'void *'
// S : LPWSTR out -> 'uint16_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ntdll.dll", {
  RtlIpv6AddressToStringW: { parameters: ["pointer", "buffer"], result: "pointer" },
});
// lib.symbols.RtlIpv6AddressToStringW(Addr, S)
// Addr : IN6_ADDR* -> "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* RtlIpv6AddressToStringW(
    void* Addr,
    uint16_t* S);
C, "ntdll.dll");
// $ffi->RtlIpv6AddressToStringW(Addr, S);
// Addr : IN6_ADDR*
// 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 RtlIpv6AddressToStringW(
        Pointer Addr,   // IN6_ADDR*
        char[] S   // LPWSTR out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("ntdll")]
lib Libntdll
  fun RtlIpv6AddressToStringW = RtlIpv6AddressToStringW(
    Addr : IN6_ADDR*,   # IN6_ADDR*
    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 RtlIpv6AddressToStringWNative = Pointer<Utf16> Function(Pointer<Void>, Pointer<Utf16>);
typedef RtlIpv6AddressToStringWDart = Pointer<Utf16> Function(Pointer<Void>, Pointer<Utf16>);
final RtlIpv6AddressToStringW = DynamicLibrary.open('ntdll.dll')
    .lookupFunction<RtlIpv6AddressToStringWNative, RtlIpv6AddressToStringWDart>('RtlIpv6AddressToStringW');
// Addr : IN6_ADDR* -> Pointer<Void>
// S : LPWSTR out -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RtlIpv6AddressToStringW(
  Addr: Pointer;   // IN6_ADDR*
  S: PWideChar   // LPWSTR out
): PWideChar; stdcall;
  external 'ntdll.dll' name 'RtlIpv6AddressToStringW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let rtlipv6addresstostringw =
  foreign "RtlIpv6AddressToStringW"
    ((ptr void) @-> (ptr uint16_t) @-> returning (ptr uint16_t))
(* Addr : IN6_ADDR* -> (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 ("RtlIpv6AddressToStringW" rtl-ipv6-address-to-string-w :convention :stdcall) (:string :encoding :utf-16le)
  (addr :pointer)   ; IN6_ADDR*
  (s :pointer))   ; LPWSTR out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RtlIpv6AddressToStringW = Win32::API::More->new('ntdll',
    'LPWSTR RtlIpv6AddressToStringW(LPVOID Addr, LPWSTR S)');
# my $ret = $RtlIpv6AddressToStringW->Call($Addr, $S);
# Addr : IN6_ADDR* -> LPVOID
# S : LPWSTR out -> LPWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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