inet_pton
関数シグネチャ
// WS2_32.dll
#include <windows.h>
INT inet_pton(
INT Family,
LPCSTR pszAddrString,
void* pAddrBuf
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|---|
| Family | INT | in | アドレスファミリです。 アドレスファミリに指定可能な値は Ws2def.h ヘッダーファイルで定義されています。Ws2def.h ヘッダーファイルは Winsock2.h に自動的にインクルードされるため、直接使用しないでください。AF_ アドレスファミリ定数と PF_ プロトコルファミリ定数の値は同一であり(例: AF_INET と PF_INET)、どちらの定数も使用できます。 現在サポートされている値は AF_INET と AF_INET6 です。
| ||||||
| pszAddrString | LPCSTR | in | 数値のバイナリ形式に変換する IP アドレスのテキスト表現を含む、NULL 終端文字列へのポインターです。 Family パラメーターが AF_INET の場合、pszAddrString パラメーターは、標準のドット区切り 10 進数表記による IPv4 アドレスのテキスト表現を指し示す必要があります。 Family パラメーターが AF_INET6 の場合、pszAddrString パラメーターは、標準表記による IPv6 アドレスのテキスト表現を指し示す必要があります。 | ||||||
| pAddrBuf | void* | out | IP アドレスの数値バイナリ表現を格納するバッファーへのポインターです。IP アドレスはネットワークバイトオーダーで返されます。 Family パラメーターが AF_INET の場合、このバッファーは IN_ADDR 構造体を格納できる十分な大きさである必要があります。 Family パラメーターが AF_INET6 の場合、このバッファーは IN6_ADDR 構造体を格納できる十分な大きさである必要があります。 |
戻り値の型: INT
公式ドキュメント
InetPton 関数は、標準のテキスト表現形式で表された IPv4 または IPv6 のインターネットネットワークアドレスを、数値のバイナリ形式に変換します。この関数の ANSI 版は inet_pton です。(InetPtonA または inet_pton)
戻り値
エラーが発生しない場合、InetPton 関数は値 1 を返し、pAddrBuf パラメーターが指すバッファーにはネットワークバイトオーダーのバイナリ数値 IP アドレスが格納されます。
pAddrBuf パラメーターが、有効な IPv4 ドット区切り 10 進数文字列でも有効な IPv6 アドレス文字列でもない文字列を指している場合、InetPton 関数は値 0 を返します。それ以外の場合は値 -1 が返され、WSAGetLastError を呼び出すことで具体的なエラーコードを取得して拡張エラー情報を得ることができます。
関数でエラーが発生した場合、WSAGetLastError が返す拡張エラーコードは、次のいずれかの値になります。
| エラーコード | 意味 |
|---|---|
| Family パラメーターで指定されたアドレスファミリがサポートされていません。このエラーは、指定された Family パラメーターが AF_INET でも AF_INET6 でもない場合に返されます。 | |
| pszAddrString パラメーターまたは pAddrBuf パラメーターが NULL であるか、ユーザーアドレス空間の一部ではありません。 |
解説(Remarks)
InetPton 関数は Windows Vista 以降でサポートされています。
InetPton 関数は、標準のテキスト表現形式で表されたインターネットネットワークアドレスを数値のバイナリ形式へ、プロトコルに依存しない方法で変換します。InetPton 関数は、pszAddrString パラメーターが指すインターネットアドレスのテキスト表現を受け取り、pAddrBuf パラメーターに数値バイナリ IP アドレスへのポインターを返します。inet_addr 関数が IPv4 アドレス文字列のみを扱うのに対し、InetPton 関数は IPv4 と IPv6 のどちらのアドレス文字列も扱えます。
この関数の ANSI 版は、RFC 2553 で定義されている inet_pton です。詳細については、IETF の Web サイトで公開されている RFC 2553 を参照してください。
InetPton 関数は、IP アドレスを表すテキスト文字列を数値バイナリ IP アドレスへ変換するために、Windows Sockets DLL の読み込みを必要としません。
指定された Family パラメーターが AF_INET の場合、pszAddrString パラメーターは、ドット区切り 10 進数表記による IPv4 アドレスのテキスト文字列(例: "192.168.16.0" はドット区切り 10 進数表記の IPv4 アドレスの一例)を指し示す必要があります。
指定された Family パラメーターが AF_INET6 の場合、pszAddrString パラメーターは、インターネット標準形式による IPv6 アドレスのテキスト文字列を指し示す必要があります。基本的な文字列表現は、コロンで区切られた 8 個の 16 進数で構成されます。連続するゼロの並びは二重コロンで置き換えることができます。IPv6 アドレスの文字列表現中に二重コロンは 1 つしか使用できません。アドレスが IPv4 互換アドレスである場合、末尾の 32 ビットは IPv4 形式のドット区切りオクテット表記で表すことができます。
UNICODE または _UNICODE が定義されている場合、InetPton はこの関数の Unicode 版である InetPtonW として定義されます。pszAddrString パラメーターは PCWSTR データ型として定義されます。
UNICODE または _UNICODE が定義されていない場合、InetPton はこの関数の ANSI 版である InetPtonA として定義されます。この関数の ANSI 版は常に inet_pton として定義されます。pszAddrString パラメーターは PCSTR データ型として定義されます。
IN_ADDR 構造体は Inaddr.h ヘッダーファイルで定義されています。
IN6_ADDR 構造体は In6addr.h ヘッダーファイルで定義されています。
Windows Vista 以降では、RtlIpv4StringToAddress 関数および RtlIpv4StringToAddressEx 関数を使用して、インターネット標準のドット区切り 10 進数表記による IPv4 アドレスのテキスト表現を、IN_ADDR 構造体として表される数値バイナリアドレスに変換できます。Windows Vista 以降では、RtlIpv6StringToAddress 関数および RtlIpv6StringToAddressEx 関数を使用して、IPv6 アドレスの文字列表現を、IN6_ADDR 構造体として表される数値バイナリ IPv6 アドレスに変換できます。RtlIpv6StringToAddressEx 関数は、標準表記でスコープ ID とポートを含めることができる IPv6 アドレスの文字列表現も数値バイナリ形式に変換できるため、より柔軟です。
Windows 8.1 および Windows Server 2012 R2: InetPtonW 関数は、Windows 8.1、Windows Server 2012 R2 以降の Windows ストアアプリでサポートされています。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// WS2_32.dll
#include <windows.h>
INT inet_pton(
INT Family,
LPCSTR pszAddrString,
void* pAddrBuf
);[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern int inet_pton(
int Family, // INT
[MarshalAs(UnmanagedType.LPStr)] string pszAddrString, // LPCSTR
IntPtr pAddrBuf // void* out
);<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function inet_pton(
Family As Integer, ' INT
<MarshalAs(UnmanagedType.LPStr)> pszAddrString As String, ' LPCSTR
pAddrBuf As IntPtr ' void* out
) As Integer
End Function' Family : INT
' pszAddrString : LPCSTR
' pAddrBuf : void* out
Declare PtrSafe Function inet_pton Lib "ws2_32" ( _
ByVal Family As Long, _
ByVal pszAddrString As String, _
ByVal pAddrBuf As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
inet_pton = ctypes.windll.ws2_32.inet_pton
inet_pton.restype = ctypes.c_int
inet_pton.argtypes = [
ctypes.c_int, # Family : INT
wintypes.LPCSTR, # pszAddrString : LPCSTR
ctypes.POINTER(None), # pAddrBuf : void* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('WS2_32.dll')
inet_pton = Fiddle::Function.new(
lib['inet_pton'],
[
Fiddle::TYPE_INT, # Family : INT
Fiddle::TYPE_VOIDP, # pszAddrString : LPCSTR
Fiddle::TYPE_VOIDP, # pAddrBuf : void* out
],
Fiddle::TYPE_INT)#[link(name = "ws2_32")]
extern "system" {
fn inet_pton(
Family: i32, // INT
pszAddrString: *const u8, // LPCSTR
pAddrBuf: *mut () // void* out
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("WS2_32.dll", SetLastError = true)]
public static extern int inet_pton(int Family, [MarshalAs(UnmanagedType.LPStr)] string pszAddrString, IntPtr pAddrBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_inet_pton' -Namespace Win32 -PassThru
# $api::inet_pton(Family, pszAddrString, pAddrBuf)#uselib "WS2_32.dll"
#func global inet_pton "inet_pton" sptr, sptr, sptr
; inet_pton Family, pszAddrString, pAddrBuf ; 戻り値は stat
; Family : INT -> "sptr"
; pszAddrString : LPCSTR -> "sptr"
; pAddrBuf : void* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "WS2_32.dll"
#cfunc global inet_pton "inet_pton" int, str, sptr
; res = inet_pton(Family, pszAddrString, pAddrBuf)
; Family : INT -> "int"
; pszAddrString : LPCSTR -> "str"
; pAddrBuf : void* out -> "sptr"; INT inet_pton(INT Family, LPCSTR pszAddrString, void* pAddrBuf)
#uselib "WS2_32.dll"
#cfunc global inet_pton "inet_pton" int, str, intptr
; res = inet_pton(Family, pszAddrString, pAddrBuf)
; Family : INT -> "int"
; pszAddrString : LPCSTR -> "str"
; pAddrBuf : void* out -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
procinet_pton = ws2_32.NewProc("inet_pton")
)
// Family (INT), pszAddrString (LPCSTR), pAddrBuf (void* out)
r1, _, err := procinet_pton.Call(
uintptr(Family),
uintptr(unsafe.Pointer(windows.BytePtrFromString(pszAddrString))),
uintptr(pAddrBuf),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction inet_pton(
Family: Integer; // INT
pszAddrString: PAnsiChar; // LPCSTR
pAddrBuf: Pointer // void* out
): Integer; stdcall;
external 'WS2_32.dll' name 'inet_pton';result := DllCall("WS2_32\inet_pton"
, "Int", Family ; INT
, "AStr", pszAddrString ; LPCSTR
, "Ptr", pAddrBuf ; void* out
, "Int") ; return: INT●inet_pton(Family, pszAddrString, pAddrBuf) = DLL("WS2_32.dll", "int inet_pton(int, char*, void*)")
# 呼び出し: inet_pton(Family, pszAddrString, pAddrBuf)
# Family : INT -> "int"
# pszAddrString : LPCSTR -> "char*"
# pAddrBuf : void* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "ws2_32" fn inet_pton(
Family: i32, // INT
pszAddrString: [*c]const u8, // LPCSTR
pAddrBuf: ?*anyopaque // void* out
) callconv(std.os.windows.WINAPI) i32;proc inet_pton(
Family: int32, # INT
pszAddrString: cstring, # LPCSTR
pAddrBuf: pointer # void* out
): int32 {.importc: "inet_pton", stdcall, dynlib: "WS2_32.dll".}pragma(lib, "ws2_32");
extern(Windows)
int inet_pton(
int Family, // INT
const(char)* pszAddrString, // LPCSTR
void* pAddrBuf // void* out
);ccall((:inet_pton, "WS2_32.dll"), stdcall, Int32,
(Int32, Cstring, Ptr{Cvoid}),
Family, pszAddrString, pAddrBuf)
# Family : INT -> Int32
# pszAddrString : LPCSTR -> Cstring
# pAddrBuf : void* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t inet_pton(
int32_t Family,
const char* pszAddrString,
void* pAddrBuf);
]]
local ws2_32 = ffi.load("ws2_32")
-- ws2_32.inet_pton(Family, pszAddrString, pAddrBuf)
-- Family : INT
-- pszAddrString : LPCSTR
-- pAddrBuf : void* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('WS2_32.dll');
const inet_pton = lib.func('__stdcall', 'inet_pton', 'int32_t', ['int32_t', 'str', 'void *']);
// inet_pton(Family, pszAddrString, pAddrBuf)
// Family : INT -> 'int32_t'
// pszAddrString : LPCSTR -> 'str'
// pAddrBuf : void* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("WS2_32.dll", {
inet_pton: { parameters: ["i32", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.inet_pton(Family, pszAddrString, pAddrBuf)
// Family : INT -> "i32"
// pszAddrString : LPCSTR -> "buffer"
// pAddrBuf : void* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t inet_pton(
int32_t Family,
const char* pszAddrString,
void* pAddrBuf);
C, "WS2_32.dll");
// $ffi->inet_pton(Family, pszAddrString, pAddrBuf);
// Family : INT
// pszAddrString : LPCSTR
// pAddrBuf : void* 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 Ws2_32 extends StdCallLibrary {
Ws2_32 INSTANCE = Native.load("ws2_32", Ws2_32.class);
int inet_pton(
int Family, // INT
String pszAddrString, // LPCSTR
Pointer pAddrBuf // void* out
);
}@[Link("ws2_32")]
lib LibWS2_32
fun inet_pton = inet_pton(
Family : Int32, # INT
pszAddrString : UInt8*, # LPCSTR
pAddrBuf : Void* # void* out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef inet_ptonNative = Int32 Function(Int32, Pointer<Utf8>, Pointer<Void>);
typedef inet_ptonDart = int Function(int, Pointer<Utf8>, Pointer<Void>);
final inet_pton = DynamicLibrary.open('WS2_32.dll')
.lookupFunction<inet_ptonNative, inet_ptonDart>('inet_pton');
// Family : INT -> Int32
// pszAddrString : LPCSTR -> Pointer<Utf8>
// pAddrBuf : void* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function inet_pton(
Family: Integer; // INT
pszAddrString: PAnsiChar; // LPCSTR
pAddrBuf: Pointer // void* out
): Integer; stdcall;
external 'WS2_32.dll' name 'inet_pton';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "inet_pton"
c_inet_pton :: Int32 -> CString -> Ptr () -> IO Int32
-- Family : INT -> Int32
-- pszAddrString : LPCSTR -> CString
-- pAddrBuf : void* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let inet_pton =
foreign "inet_pton"
(int32_t @-> string @-> (ptr void) @-> returning int32_t)
(* Family : INT -> int32_t *)
(* pszAddrString : LPCSTR -> string *)
(* pAddrBuf : void* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library ws2_32 (t "WS2_32.dll"))
(cffi:use-foreign-library ws2_32)
(cffi:defcfun ("inet_pton" inet-pton :convention :stdcall) :int32
(family :int32) ; INT
(psz-addr-string :string) ; LPCSTR
(p-addr-buf :pointer)) ; void* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $inet_pton = Win32::API::More->new('WS2_32',
'int inet_pton(int Family, LPCSTR pszAddrString, LPVOID pAddrBuf)');
# my $ret = $inet_pton->Call($Family, $pszAddrString, $pAddrBuf);
# Family : INT -> int
# pszAddrString : LPCSTR -> LPCSTR
# pAddrBuf : void* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- s IN_ADDR
- f InetNtopW — バイナリ形式のIPアドレスをUnicode文字列形式に変換する。
- f RtlIpv4AddressToStringW — IPv4アドレスをドット区切り文字列へ変換する。
- f RtlIpv4AddressToStringExW — IPv4アドレスとポートを文字列へ変換する。
- f RtlIpv4StringToAddressW — 文字列をIPv4アドレス構造体へ変換する。
- f RtlIpv4StringToAddressExW — 文字列をIPv4アドレスとポートへ変換する。
- f RtlIpv6AddressToStringW — IPv6アドレスを文字列表現へ変換する。
- f RtlIpv6AddressToStringExW — IPv6アドレスとスコープ・ポートを文字列へ変換する。
- f RtlIpv6StringToAddressW — 文字列をIPv6アドレス構造体へ変換する。
- f RtlIpv6StringToAddressExW — 文字列をIPv6アドレスとスコープ・ポートへ変換する。
- f inet_addr — IPアドレス文字列を32ビットアドレスへ変換する。
- f inet_ntoa — IPアドレスをドット区切りの文字列へ変換する。