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

RtlIpv4AddressToStringExA

関数
IPv4アドレスとポートを文字列へ変換する。
DLLntdll.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

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

INT RtlIpv4AddressToStringExA(
    const IN_ADDR* Address,
    WORD Port,
    LPSTR AddressString,
    DWORD* AddressStringLength
);

パラメーター

名前方向説明
AddressIN_ADDR*inネットワーク バイト オーダーの IPv4 アドレス。
PortWORDinネットワーク バイト オーダー形式のポート番号。このパラメーターは省略可能です。
AddressStringLPSTRoutIPv4 アドレスとポートの NULL 終端文字列表現を受け取るバッファーへのポインター。このバッファーは、少なくとも INET_ADDRSTRLEN 文字を保持できる十分な大きさである必要があります。INET_ADDRSTRLEN 値は Ws2ipdef.h ヘッダー ファイルで定義されています。
AddressStringLengthDWORD*inout

入力時には、AddressString パラメーターが指すバッファーに収まる文字数を、NULL 終端文字を含めて指定します。

出力時には、このパラメーターには AddressString パラメーターが指すバッファーに実際に書き込まれた文字数が格納されます。

戻り値の型: INT

公式ドキュメント

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

戻り値

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

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

戻り値コード 説明
STATUS_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。このエラーは、AddressString または AddressStringLength パラメーターに NULL ポインターが渡された場合に返されます。また、AddressString パラメーターが指すバッファーの長さが、IPv4 アドレスとポートの文字列表現を受け取るのに十分でない場合にも返されます。
その他
FormatMessage を使用して、返されたエラーのメッセージ文字列を取得してください。

解説(Remarks)

RtlIpv4AddressToStringEx 関数は、IPv4 アドレスとポート番号を、インターネットのドット区切り 10 進形式による IPv4 アドレスの文字列表現に、コロン文字とポートの文字列表現を続けた形式に変換するために使用します。

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

AddressString パラメーターが指すバッファーの長さが、IPv4 アドレスとポートの文字列表現を受け取るのに十分でない場合、RtlIpv4AddressToStringExERROR_INVALID_PARAMETER を返し、AddressStringLength パラメーターに必要なバッファー長を設定します。

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

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

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 RtlIpv4AddressToStringExA(
    const IN_ADDR* Address,
    WORD Port,
    LPSTR AddressString,
    DWORD* AddressStringLength
);
[DllImport("ntdll.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int RtlIpv4AddressToStringExA(
    IntPtr Address,   // IN_ADDR*
    ushort Port,   // WORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder AddressString,   // LPSTR out
    ref uint AddressStringLength   // DWORD* in/out
);
<DllImport("ntdll.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RtlIpv4AddressToStringExA(
    Address As IntPtr,   ' IN_ADDR*
    Port As UShort,   ' WORD
    <MarshalAs(UnmanagedType.LPStr)> AddressString As System.Text.StringBuilder,   ' LPSTR out
    ByRef AddressStringLength As UInteger   ' DWORD* in/out
) As Integer
End Function
' Address : IN_ADDR*
' Port : WORD
' AddressString : LPSTR out
' AddressStringLength : DWORD* in/out
Declare PtrSafe Function RtlIpv4AddressToStringExA Lib "ntdll" ( _
    ByVal Address As LongPtr, _
    ByVal Port As Integer, _
    ByVal AddressString As String, _
    ByRef AddressStringLength As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RtlIpv4AddressToStringExA = ctypes.windll.ntdll.RtlIpv4AddressToStringExA
RtlIpv4AddressToStringExA.restype = ctypes.c_int
RtlIpv4AddressToStringExA.argtypes = [
    ctypes.c_void_p,  # Address : IN_ADDR*
    ctypes.c_ushort,  # Port : WORD
    wintypes.LPSTR,  # AddressString : LPSTR out
    ctypes.POINTER(wintypes.DWORD),  # AddressStringLength : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ntdll = windows.NewLazySystemDLL("ntdll.dll")
	procRtlIpv4AddressToStringExA = ntdll.NewProc("RtlIpv4AddressToStringExA")
)

// Address (IN_ADDR*), Port (WORD), AddressString (LPSTR out), AddressStringLength (DWORD* in/out)
r1, _, err := procRtlIpv4AddressToStringExA.Call(
	uintptr(Address),
	uintptr(Port),
	uintptr(AddressString),
	uintptr(AddressStringLength),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function RtlIpv4AddressToStringExA(
  Address: Pointer;   // IN_ADDR*
  Port: Word;   // WORD
  AddressString: PAnsiChar;   // LPSTR out
  AddressStringLength: Pointer   // DWORD* in/out
): Integer; stdcall;
  external 'ntdll.dll' name 'RtlIpv4AddressToStringExA';
result := DllCall("ntdll\RtlIpv4AddressToStringExA"
    , "Ptr", Address   ; IN_ADDR*
    , "UShort", Port   ; WORD
    , "Ptr", AddressString   ; LPSTR out
    , "Ptr", AddressStringLength   ; DWORD* in/out
    , "Int")   ; return: INT
●RtlIpv4AddressToStringExA(Address, Port, AddressString, AddressStringLength) = DLL("ntdll.dll", "int RtlIpv4AddressToStringExA(void*, int, char*, void*)")
# 呼び出し: RtlIpv4AddressToStringExA(Address, Port, AddressString, AddressStringLength)
# Address : IN_ADDR* -> "void*"
# Port : WORD -> "int"
# AddressString : LPSTR out -> "char*"
# AddressStringLength : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef RtlIpv4AddressToStringExANative = Int32 Function(Pointer<Void>, Uint16, Pointer<Utf8>, Pointer<Uint32>);
typedef RtlIpv4AddressToStringExADart = int Function(Pointer<Void>, int, Pointer<Utf8>, Pointer<Uint32>);
final RtlIpv4AddressToStringExA = DynamicLibrary.open('ntdll.dll')
    .lookupFunction<RtlIpv4AddressToStringExANative, RtlIpv4AddressToStringExADart>('RtlIpv4AddressToStringExA');
// Address : IN_ADDR* -> Pointer<Void>
// Port : WORD -> Uint16
// AddressString : LPSTR out -> Pointer<Utf8>
// AddressStringLength : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RtlIpv4AddressToStringExA(
  Address: Pointer;   // IN_ADDR*
  Port: Word;   // WORD
  AddressString: PAnsiChar;   // LPSTR out
  AddressStringLength: Pointer   // DWORD* in/out
): Integer; stdcall;
  external 'ntdll.dll' name 'RtlIpv4AddressToStringExA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RtlIpv4AddressToStringExA"
  c_RtlIpv4AddressToStringExA :: Ptr () -> Word16 -> CString -> Ptr Word32 -> IO Int32
-- Address : IN_ADDR* -> Ptr ()
-- Port : WORD -> Word16
-- AddressString : LPSTR out -> CString
-- AddressStringLength : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rtlipv4addresstostringexa =
  foreign "RtlIpv4AddressToStringExA"
    ((ptr void) @-> uint16_t @-> string @-> (ptr uint32_t) @-> returning int32_t)
(* Address : IN_ADDR* -> (ptr void) *)
(* Port : WORD -> uint16_t *)
(* AddressString : LPSTR out -> string *)
(* AddressStringLength : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ntdll (t "ntdll.dll"))
(cffi:use-foreign-library ntdll)

(cffi:defcfun ("RtlIpv4AddressToStringExA" rtl-ipv4-address-to-string-ex-a :convention :stdcall) :int32
  (address :pointer)   ; IN_ADDR*
  (port :uint16)   ; WORD
  (address-string :pointer)   ; LPSTR out
  (address-string-length :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RtlIpv4AddressToStringExA = Win32::API::More->new('ntdll',
    'int RtlIpv4AddressToStringExA(LPVOID Address, WORD Port, LPSTR AddressString, LPVOID AddressStringLength)');
# my $ret = $RtlIpv4AddressToStringExA->Call($Address, $Port, $AddressString, $AddressStringLength);
# Address : IN_ADDR* -> LPVOID
# Port : WORD -> WORD
# AddressString : LPSTR out -> LPSTR
# AddressStringLength : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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