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

RtlIpv6StringToAddressA

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

シグネチャ

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

INT RtlIpv6StringToAddressA(
    LPCSTR S,
    LPCSTR* Terminator,
    IN6_ADDR* Addr
);

パラメーター

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

戻り値の型: INT

公式ドキュメント

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

戻り値

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

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

戻り値 説明
STATUS_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。このエラーは、S パラメーターが指す文字列が IPv6 アドレスの正しい文字列表現を含んでいない場合に返されます。

このエラーコードは Ntstatus.h ヘッダーファイルで定義されています。

その他
返されたエラーに対応するメッセージ文字列を取得するには、 FormatMessage を使用してください。

解説(Remarks)

RtlIpv6StringToAddress 関数は、IPv6 アドレスの文字列表現を、ネットワークオーダー(バイトが左から右へ並ぶ順序)で返される IPv6 アドレスに変換するために使用します。

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

S パラメーターが指す文字列は、IPv6 アドレス文字列の形式で表現されている必要があります。IPv6 アドレスの基本的な文字列表現は、コロンで区切られた 8 個の 16 進数で構成されます。連続するゼロの並びは、二重コロンに置き換えることができます。IPv6 アドレスの文字列表現中に二重コロンは 1 つしか使用できません。アドレスが IPv4 互換アドレス、IPv4 射影 IPv6 アドレス、または ISATAP アドレスである場合、下位 32 ビットは IPv4 スタイルのドット区切りオクテット表記で表現できます。詳細については、IETF が公開している RFC 5942 のセクション 5 を参照してください。

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

一部の不正な形式の IPv6 アドレス(たとえば :::: など)は、有効な IPv6 アドレスで始まっています。RtlIpv6StringToAddress 関数は、IPv6 アドレスの有効な部分を二重コロン(::)として解析し、成功を返します。その場合、Terminator は 3 つ目のコロンを指します。渡された文字列全体が有効な IPv6 アドレスであることを検証するには、Terminator が正しい文字を指していることを確認する必要があります。S パラメーターに IPv6 アドレスのみが含まれている場合、Terminator は文字列末尾の NULL 文字を指しているはずです。
UNICODE または _UNICODE のいずれかが定義されている場合、RtlIpv6StringToAddress はこの関数の Unicode 版である RtlIpv6StringToAddressW として定義されます。S および Terminator パラメーターは PCWSTR データ型として定義されます。

UNICODE と _UNICODE のどちらも定義されていない場合、RtlIpv6StringToAddress はこの関数の ANSI 版である RtlIpv6StringToAddressA として定義されます。S および Terminator パラメーターは PCSTR データ型として定義されます。

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 RtlIpv6StringToAddressA(
    LPCSTR S,
    LPCSTR* Terminator,
    IN6_ADDR* Addr
);
[DllImport("ntdll.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int RtlIpv6StringToAddressA(
    [MarshalAs(UnmanagedType.LPStr)] string S,   // LPCSTR
    IntPtr Terminator,   // LPCSTR* out
    IntPtr Addr   // IN6_ADDR* out
);
<DllImport("ntdll.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RtlIpv6StringToAddressA(
    <MarshalAs(UnmanagedType.LPStr)> S As String,   ' LPCSTR
    Terminator As IntPtr,   ' LPCSTR* out
    Addr As IntPtr   ' IN6_ADDR* out
) As Integer
End Function
' S : LPCSTR
' Terminator : LPCSTR* out
' Addr : IN6_ADDR* out
Declare PtrSafe Function RtlIpv6StringToAddressA 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

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

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

var (
	ntdll = windows.NewLazySystemDLL("ntdll.dll")
	procRtlIpv6StringToAddressA = ntdll.NewProc("RtlIpv6StringToAddressA")
)

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

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

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

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

let rtlipv6stringtoaddressa =
  foreign "RtlIpv6StringToAddressA"
    (string @-> (ptr string) @-> (ptr void) @-> returning int32_t)
(* S : LPCSTR -> string *)
(* Terminator : LPCSTR* out -> (ptr string) *)
(* Addr : IN6_ADDR* 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 ("RtlIpv6StringToAddressA" rtl-ipv6-string-to-address-a :convention :stdcall) :int32
  (s :string)   ; LPCSTR
  (terminator :pointer)   ; LPCSTR* out
  (addr :pointer))   ; IN6_ADDR* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RtlIpv6StringToAddressA = Win32::API::More->new('ntdll',
    'int RtlIpv6StringToAddressA(LPCSTR S, LPVOID Terminator, LPVOID Addr)');
# my $ret = $RtlIpv6StringToAddressA->Call($S, $Terminator, $Addr);
# S : LPCSTR -> LPCSTR
# Terminator : LPCSTR* out -> LPVOID
# Addr : IN6_ADDR* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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