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

RtlIpv6AddressToStringA

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

シグネチャ

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

LPSTR RtlIpv6AddressToStringA(
    const IN6_ADDR* Addr,
    LPSTR S
);

パラメーター

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

戻り値の型: LPSTR

公式ドキュメント

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

戻り値

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  (ANSI / -A)
#include <windows.h>

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

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

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

var (
	ntdll = windows.NewLazySystemDLL("ntdll.dll")
	procRtlIpv6AddressToStringA = ntdll.NewProc("RtlIpv6AddressToStringA")
)

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

extern "ntdll" fn RtlIpv6AddressToStringA(
    Addr: [*c]IN6_ADDR, // IN6_ADDR*
    S: [*c]u8 // LPSTR out
) callconv(std.os.windows.WINAPI) [*c]const u8;
proc RtlIpv6AddressToStringA(
    Addr: ptr IN6_ADDR,  # IN6_ADDR*
    S: ptr char  # LPSTR out
): cstring {.importc: "RtlIpv6AddressToStringA", stdcall, dynlib: "ntdll.dll".}
pragma(lib, "ntdll");
extern(Windows)
const(char)* RtlIpv6AddressToStringA(
    IN6_ADDR* Addr,   // IN6_ADDR*
    char* S   // LPSTR out
);
ccall((:RtlIpv6AddressToStringA, "ntdll.dll"), stdcall, Cstring,
      (Ptr{IN6_ADDR}, Ptr{UInt8}),
      Addr, S)
# Addr : IN6_ADDR* -> Ptr{IN6_ADDR}
# S : LPSTR out -> Ptr{UInt8}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
const char* RtlIpv6AddressToStringA(
    void* Addr,
    char* S);
]]
local ntdll = ffi.load("ntdll")
-- ntdll.RtlIpv6AddressToStringA(Addr, S)
-- Addr : IN6_ADDR*
-- S : LPSTR out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ntdll.dll');
const RtlIpv6AddressToStringA = lib.func('__stdcall', 'RtlIpv6AddressToStringA', 'void *', ['void *', 'char *']);
// RtlIpv6AddressToStringA(Addr, S)
// Addr : IN6_ADDR* -> 'void *'
// S : LPSTR out -> 'char *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ntdll.dll", {
  RtlIpv6AddressToStringA: { parameters: ["pointer", "buffer"], result: "pointer" },
});
// lib.symbols.RtlIpv6AddressToStringA(Addr, S)
// Addr : IN6_ADDR* -> "pointer"
// S : LPSTR out -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
const char* RtlIpv6AddressToStringA(
    void* Addr,
    char* S);
C, "ntdll.dll");
// $ffi->RtlIpv6AddressToStringA(Addr, S);
// Addr : IN6_ADDR*
// S : LPSTR 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);
    Pointer RtlIpv6AddressToStringA(
        Pointer Addr,   // IN6_ADDR*
        byte[] S   // LPSTR out
    );
}
@[Link("ntdll")]
lib Libntdll
  fun RtlIpv6AddressToStringA = RtlIpv6AddressToStringA(
    Addr : IN6_ADDR*,   # IN6_ADDR*
    S : UInt8*   # LPSTR out
  ) : UInt8*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

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

関連項目

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