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

RtlIpv4StringToAddressExW

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

シグネチャ

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

INT RtlIpv4StringToAddressExW(
    LPCWSTR AddressString,
    BOOLEAN Strict,
    IN_ADDR* Address,
    WORD* Port
);

パラメーター

名前方向説明
AddressStringLPCWSTRinIPv4 アドレスの NULL 終端文字列表現に、省略可能なコロンとポート番号の文字列表現が続いたものを格納するバッファへのポインターです。
StrictBOOLEANin文字列を厳密な 4 部構成のドット区切り 10 進表記で表された IPv4 アドレスにする必要があるかどうかを示す値です。このパラメーターが TRUE の場合、文字列は 4 つの部分から成るドット区切り 10 進表記でなければなりません。このパラメーターが FALSE の場合、IPv4 アドレスの文字列表現には 4 つの形式のいずれかを使用でき、10 進、8 進、または 16 進表記が許可されます。詳細については「解説」セクションを参照してください。
AddressIN_ADDR*outIPv4 アドレスのバイナリ表現を格納するポインターです。IPv4 アドレスはネットワーク バイト オーダーで格納されます。
PortWORD*outポート番号のバイナリ表現を格納するポインターです。ポート番号はネットワーク バイト オーダーで返されます。AddressString パラメーターが指す文字列にポートが指定されていなかった場合、Port パラメーターには 0 が設定されます。

戻り値の型: INT

公式ドキュメント

IPv4 アドレスとポート番号の文字列表現を、バイナリ形式の IPv4 アドレスとポートに変換します。(Unicode)

戻り値

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

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

戻り値 説明
STATUS_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。このエラーは、Strict パラメーターが TRUE に設定されているにもかかわらず、AddressString パラメーターが指す文字列に 4 部構成のドット区切り 10 進形式の IPv4 アドレス文字列表現が含まれていなかった場合に返されます。また、AddressString パラメーターが指す文字列に適切な IPv4 アドレスの文字列表現が含まれていなかった場合にも返されます。

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

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

解説(Remarks)

RtlIpv4StringToAddressEx 関数は、IPv4 アドレスとポート番号の文字列表現を、バイナリ形式の IPv4 アドレスとポート番号に変換するために使用されます。IPv4 アドレスはネットワーク オーダー(バイトが左から右へ順序付けられる)で返されます。ポート番号もネットワーク オーダーで返されます。

RtlIpv4StringToAddressEx は、文字列から IP アドレスへの変換を実行するために Windows Sockets が提供する関数へアクセスする際に、Windows Sockets DLL を読み込む必要のない便利な関数です。

Strict パラメーターが TRUE に設定されている場合、AddressString パラメーターが指す文字列は厳密なドット区切り 10 進表記でなければなりません。この厳密な形式では 4 つの部分を指定する必要があります。各部分は 10 進のデータ バイトとして解釈され、左から右へ IPv4 アドレスの 4 バイトに割り当てられます。

Strict パラメーターが FALSE に設定されている場合、AddressString パラメーターが指す文字列はいくつかの形式のいずれであっても構いません。AddressString パラメーターが指すバッファに 3 部構成のアドレス文字列が含まれている場合、最後の部分は 16 ビットの値として解釈され、ネットワーク アドレスの右端 2 バイトに配置されます。これにより、3 部構成のアドレス形式はクラス B ネットワーク アドレスを「128.net.host」のように指定するのに便利です。AddressString パラメーターが指すバッファに 2 部構成のアドレス文字列が含まれている場合、最後の部分は 24 ビットの値として解釈され、ネットワーク アドレスの右端 3 バイトに配置されます。これにより、2 部構成のアドレス形式はクラス A ネットワーク アドレスを「net.host」のように指定するのに便利です。AddressString パラメーターが指すバッファに 1 部構成のアドレス文字列のみが含まれている場合、その値はバイトの並べ替えを行わずにそのままネットワーク アドレスに格納されます。

AddressString パラメーターが指すバッファには、IPv4 アドレス文字列に続けて、省略可能なコロンとポート番号の文字列表現を含めることができます。AddressString パラメーターが指すバッファにポート番号文字列が含まれている場合、ポート番号のバイナリ表現が Port パラメーターに返されます。AddressString パラメーターが指すバッファにポート番号が含まれていない場合、Port パラメーターには 0 が返されます。

UNICODE または _UNICODE のいずれかが定義されている場合、RtlIpv4StringToAddressEx はこの関数の Unicode バージョンである RtlIpv4StringToAddressExW として定義されます。AddressString パラメーターは PCWSTR データ型として定義されます。

UNICODE と _UNICODE のどちらも定義されていない場合、RtlIpv4StringToAddressEx はこの関数の ANSI バージョンである RtlIpv4StringToAddressExA として定義されます。AddressString パラメーターは PCSTR データ型として定義されます。

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 RtlIpv4StringToAddressExW(
    LPCWSTR AddressString,
    BOOLEAN Strict,
    IN_ADDR* Address,
    WORD* Port
);
[DllImport("ntdll.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int RtlIpv4StringToAddressExW(
    [MarshalAs(UnmanagedType.LPWStr)] string AddressString,   // LPCWSTR
    [MarshalAs(UnmanagedType.U1)] bool Strict,   // BOOLEAN
    IntPtr Address,   // IN_ADDR* out
    out ushort Port   // WORD* out
);
<DllImport("ntdll.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function RtlIpv4StringToAddressExW(
    <MarshalAs(UnmanagedType.LPWStr)> AddressString As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.U1)> Strict As Boolean,   ' BOOLEAN
    Address As IntPtr,   ' IN_ADDR* out
    <Out> ByRef Port As UShort   ' WORD* out
) As Integer
End Function
' AddressString : LPCWSTR
' Strict : BOOLEAN
' Address : IN_ADDR* out
' Port : WORD* out
Declare PtrSafe Function RtlIpv4StringToAddressExW Lib "ntdll" ( _
    ByVal AddressString As LongPtr, _
    ByVal Strict As Byte, _
    ByVal Address As LongPtr, _
    ByRef Port As Integer) 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

RtlIpv4StringToAddressExW = ctypes.windll.ntdll.RtlIpv4StringToAddressExW
RtlIpv4StringToAddressExW.restype = ctypes.c_int
RtlIpv4StringToAddressExW.argtypes = [
    wintypes.LPCWSTR,  # AddressString : LPCWSTR
    wintypes.BOOLEAN,  # Strict : BOOLEAN
    ctypes.c_void_p,  # Address : IN_ADDR* out
    ctypes.POINTER(ctypes.c_ushort),  # Port : WORD* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ntdll = windows.NewLazySystemDLL("ntdll.dll")
	procRtlIpv4StringToAddressExW = ntdll.NewProc("RtlIpv4StringToAddressExW")
)

// AddressString (LPCWSTR), Strict (BOOLEAN), Address (IN_ADDR* out), Port (WORD* out)
r1, _, err := procRtlIpv4StringToAddressExW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(AddressString))),
	uintptr(Strict),
	uintptr(Address),
	uintptr(Port),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function RtlIpv4StringToAddressExW(
  AddressString: PWideChar;   // LPCWSTR
  Strict: ByteBool;   // BOOLEAN
  Address: Pointer;   // IN_ADDR* out
  Port: Pointer   // WORD* out
): Integer; stdcall;
  external 'ntdll.dll' name 'RtlIpv4StringToAddressExW';
result := DllCall("ntdll\RtlIpv4StringToAddressExW"
    , "WStr", AddressString   ; LPCWSTR
    , "Char", Strict   ; BOOLEAN
    , "Ptr", Address   ; IN_ADDR* out
    , "Ptr", Port   ; WORD* out
    , "Int")   ; return: INT
●RtlIpv4StringToAddressExW(AddressString, Strict, Address, Port) = DLL("ntdll.dll", "int RtlIpv4StringToAddressExW(char*, byte, void*, void*)")
# 呼び出し: RtlIpv4StringToAddressExW(AddressString, Strict, Address, Port)
# AddressString : LPCWSTR -> "char*"
# Strict : BOOLEAN -> "byte"
# Address : IN_ADDR* out -> "void*"
# Port : WORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "ntdll" fn RtlIpv4StringToAddressExW(
    AddressString: [*c]const u16, // LPCWSTR
    Strict: u8, // BOOLEAN
    Address: [*c]IN_ADDR, // IN_ADDR* out
    Port: [*c]u16 // WORD* out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc RtlIpv4StringToAddressExW(
    AddressString: WideCString,  # LPCWSTR
    Strict: uint8,  # BOOLEAN
    Address: ptr IN_ADDR,  # IN_ADDR* out
    Port: ptr uint16  # WORD* out
): int32 {.importc: "RtlIpv4StringToAddressExW", stdcall, dynlib: "ntdll.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "ntdll");
extern(Windows)
int RtlIpv4StringToAddressExW(
    const(wchar)* AddressString,   // LPCWSTR
    ubyte Strict,   // BOOLEAN
    IN_ADDR* Address,   // IN_ADDR* out
    ushort* Port   // WORD* out
);
ccall((:RtlIpv4StringToAddressExW, "ntdll.dll"), stdcall, Int32,
      (Cwstring, UInt8, Ptr{IN_ADDR}, Ptr{UInt16}),
      AddressString, Strict, Address, Port)
# AddressString : LPCWSTR -> Cwstring
# Strict : BOOLEAN -> UInt8
# Address : IN_ADDR* out -> Ptr{IN_ADDR}
# Port : WORD* out -> Ptr{UInt16}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t RtlIpv4StringToAddressExW(
    const uint16_t* AddressString,
    uint8_t Strict,
    void* Address,
    uint16_t* Port);
]]
local ntdll = ffi.load("ntdll")
-- ntdll.RtlIpv4StringToAddressExW(AddressString, Strict, Address, Port)
-- AddressString : LPCWSTR
-- Strict : BOOLEAN
-- Address : IN_ADDR* out
-- Port : WORD* 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 RtlIpv4StringToAddressExW = lib.func('__stdcall', 'RtlIpv4StringToAddressExW', 'int32_t', ['str16', 'uint8_t', 'void *', 'uint16_t *']);
// RtlIpv4StringToAddressExW(AddressString, Strict, Address, Port)
// AddressString : LPCWSTR -> 'str16'
// Strict : BOOLEAN -> 'uint8_t'
// Address : IN_ADDR* out -> 'void *'
// Port : WORD* out -> 'uint16_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ntdll.dll", {
  RtlIpv4StringToAddressExW: { parameters: ["buffer", "u8", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.RtlIpv4StringToAddressExW(AddressString, Strict, Address, Port)
// AddressString : LPCWSTR -> "buffer"
// Strict : BOOLEAN -> "u8"
// Address : IN_ADDR* out -> "pointer"
// Port : WORD* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t RtlIpv4StringToAddressExW(
    const uint16_t* AddressString,
    uint8_t Strict,
    void* Address,
    uint16_t* Port);
C, "ntdll.dll");
// $ffi->RtlIpv4StringToAddressExW(AddressString, Strict, Address, Port);
// AddressString : LPCWSTR
// Strict : BOOLEAN
// Address : IN_ADDR* out
// Port : WORD* 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);
    int RtlIpv4StringToAddressExW(
        WString AddressString,   // LPCWSTR
        byte Strict,   // BOOLEAN
        Pointer Address,   // IN_ADDR* out
        ShortByReference Port   // WORD* out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("ntdll")]
lib Libntdll
  fun RtlIpv4StringToAddressExW = RtlIpv4StringToAddressExW(
    AddressString : UInt16*,   # LPCWSTR
    Strict : UInt8,   # BOOLEAN
    Address : IN_ADDR*,   # IN_ADDR* out
    Port : UInt16*   # WORD* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef RtlIpv4StringToAddressExWNative = Int32 Function(Pointer<Utf16>, Uint8, Pointer<Void>, Pointer<Uint16>);
typedef RtlIpv4StringToAddressExWDart = int Function(Pointer<Utf16>, int, Pointer<Void>, Pointer<Uint16>);
final RtlIpv4StringToAddressExW = DynamicLibrary.open('ntdll.dll')
    .lookupFunction<RtlIpv4StringToAddressExWNative, RtlIpv4StringToAddressExWDart>('RtlIpv4StringToAddressExW');
// AddressString : LPCWSTR -> Pointer<Utf16>
// Strict : BOOLEAN -> Uint8
// Address : IN_ADDR* out -> Pointer<Void>
// Port : WORD* out -> Pointer<Uint16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RtlIpv4StringToAddressExW(
  AddressString: PWideChar;   // LPCWSTR
  Strict: ByteBool;   // BOOLEAN
  Address: Pointer;   // IN_ADDR* out
  Port: Pointer   // WORD* out
): Integer; stdcall;
  external 'ntdll.dll' name 'RtlIpv4StringToAddressExW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RtlIpv4StringToAddressExW"
  c_RtlIpv4StringToAddressExW :: CWString -> Word8 -> Ptr () -> Ptr Word16 -> IO Int32
-- AddressString : LPCWSTR -> CWString
-- Strict : BOOLEAN -> Word8
-- Address : IN_ADDR* out -> Ptr ()
-- Port : WORD* out -> Ptr Word16
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rtlipv4stringtoaddressexw =
  foreign "RtlIpv4StringToAddressExW"
    ((ptr uint16_t) @-> uint8_t @-> (ptr void) @-> (ptr uint16_t) @-> returning int32_t)
(* AddressString : LPCWSTR -> (ptr uint16_t) *)
(* Strict : BOOLEAN -> uint8_t *)
(* Address : IN_ADDR* out -> (ptr void) *)
(* Port : WORD* 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 ("RtlIpv4StringToAddressExW" rtl-ipv4-string-to-address-ex-w :convention :stdcall) :int32
  (address-string (:string :encoding :utf-16le))   ; LPCWSTR
  (strict :uint8)   ; BOOLEAN
  (address :pointer)   ; IN_ADDR* out
  (port :pointer))   ; WORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RtlIpv4StringToAddressExW = Win32::API::More->new('ntdll',
    'int RtlIpv4StringToAddressExW(LPCWSTR AddressString, BYTE Strict, LPVOID Address, LPVOID Port)');
# my $ret = $RtlIpv4StringToAddressExW->Call($AddressString, $Strict, $Address, $Port);
# AddressString : LPCWSTR -> LPCWSTR
# Strict : BOOLEAN -> BYTE
# Address : IN_ADDR* out -> LPVOID
# Port : WORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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