ホーム › Networking.WinSock › RtlIpv6StringToAddressW

RtlIpv6StringToAddressW

関数

文字列をIPv6アドレス構造体へ変換する。

DLLntdll.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

INT RtlIpv6StringToAddressW(
    LPCWSTR S,
    LPCWSTR* Terminator,
    IN6_ADDR* Addr
);

パラメーター

名前	型	方向	説明
S	LPCWSTR	in	IPv6 アドレスの NULL 終端文字列表現を格納したバッファへのポインターです。
Terminator	LPCWSTR*	out	変換された文字列を終端した文字へのポインターを受け取るパラメーターです。呼び出し側はこれを使用して、文字列から追加情報を抽出できます。
Addr	IN6_ADDR*	out	IPv6 アドレスのバイナリ表現を格納する場所へのポインターです。

戻り値の型: INT

公式ドキュメント

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

戻り値

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

INT RtlIpv6StringToAddressW(
    LPCWSTR S,
    LPCWSTR* Terminator,
    IN6_ADDR* Addr
);

[DllImport("ntdll.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int RtlIpv6StringToAddressW(
    [MarshalAs(UnmanagedType.LPWStr)] string S,   // LPCWSTR
    IntPtr Terminator,   // LPCWSTR* out
    IntPtr Addr   // IN6_ADDR* out
);

<DllImport("ntdll.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function RtlIpv6StringToAddressW(
    <MarshalAs(UnmanagedType.LPWStr)> S As String,   ' LPCWSTR
    Terminator As IntPtr,   ' LPCWSTR* out
    Addr As IntPtr   ' IN6_ADDR* out
) As Integer
End Function

' S : LPCWSTR
' Terminator : LPCWSTR* out
' Addr : IN6_ADDR* out
Declare PtrSafe Function RtlIpv6StringToAddressW Lib "ntdll" ( _
    ByVal S As LongPtr, _
    ByVal Terminator As LongPtr, _
    ByVal Addr As LongPtr) As Long
' 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

RtlIpv6StringToAddressW = ctypes.windll.ntdll.RtlIpv6StringToAddressW
RtlIpv6StringToAddressW.restype = ctypes.c_int
RtlIpv6StringToAddressW.argtypes = [
    wintypes.LPCWSTR,  # S : LPCWSTR
    ctypes.c_void_p,  # Terminator : LPCWSTR* out
    ctypes.c_void_p,  # Addr : IN6_ADDR* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ntdll.dll')
RtlIpv6StringToAddressW = Fiddle::Function.new(
  lib['RtlIpv6StringToAddressW'],
  [
    Fiddle::TYPE_VOIDP,  # S : LPCWSTR
    Fiddle::TYPE_VOIDP,  # Terminator : LPCWSTR* out
    Fiddle::TYPE_VOIDP,  # Addr : IN6_ADDR* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "ntdll")]
extern "system" {
    fn RtlIpv6StringToAddressW(
        S: *const u16,  // LPCWSTR
        Terminator: *const *const u16,  // LPCWSTR* 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.Unicode)]
public static extern int RtlIpv6StringToAddressW([MarshalAs(UnmanagedType.LPWStr)] string S, IntPtr Terminator, IntPtr Addr);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ntdll_RtlIpv6StringToAddressW' -Namespace Win32 -PassThru
# $api::RtlIpv6StringToAddressW(S, Terminator, Addr)

#uselib "ntdll.dll"
#func global RtlIpv6StringToAddressW "RtlIpv6StringToAddressW" wptr, wptr, wptr
; RtlIpv6StringToAddressW S, varptr(Terminator), varptr(Addr)   ; 戻り値は stat
; S : LPCWSTR -> "wptr"
; Terminator : LPCWSTR* out -> "wptr"
; Addr : IN6_ADDR* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ntdll.dll"
#cfunc global RtlIpv6StringToAddressW "RtlIpv6StringToAddressW" wstr, var, var
; res = RtlIpv6StringToAddressW(S, Terminator, Addr)
; S : LPCWSTR -> "wstr"
; Terminator : LPCWSTR* out -> "var"
; Addr : IN6_ADDR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ntdll.dll"
#cfunc global RtlIpv6StringToAddressW "RtlIpv6StringToAddressW" wstr, sptr, sptr
; res = RtlIpv6StringToAddressW(S, varptr(Terminator), varptr(Addr))
; S : LPCWSTR -> "wstr"
; Terminator : LPCWSTR* out -> "sptr"
; Addr : IN6_ADDR* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。