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

htonl

関数
32ビット値をホスト順からネットワークバイト順へ変換する。
DLLWS2_32.dll呼出規約winapiSetLastErrorあり対応OSWindows 8.1 以降

シグネチャ

// WS2_32.dll
#include <windows.h>

DWORD htonl(
    DWORD hostlong
);

パラメーター

名前方向説明
hostlongDWORDinホストのバイト オーダーの 32 ビットの数値。

戻り値の型: DWORD

公式ドキュメント

htonl 関数 (winsock.h) は、u_long をホストのバイト オーダーから TCP/IP のネットワーク バイト オーダー (ビッグ エンディアン) に変換します。

戻り値

htonl 関数は、TCP/IP のネットワーク バイト オーダーに変換した値を返します。

解説(Remarks)

htonl 関数は、ホストのバイト オーダーの 32 ビットの数値を受け取り、TCP/IP ネットワーク (AF_INET または AF_INET6 アドレス ファミリ) で使用されるネットワーク バイト オーダーの 32 ビットの数値を返します。

htonl 関数は、ホストのバイト オーダーの IPv4 アドレスを、ネットワーク バイト オーダーの IPv4 アドレスに変換するために使用できます。この関数は、hostlong パラメーターが有効な IPv4 アドレスかどうかを確認するチェックは一切行いません。

htonl 関数は、事前に WSAStartup 関数の呼び出しが成功して Winsock DLL が読み込まれていることを必要としません。

Windows 8.1 および Windows Server 2012 R2: この関数は、Windows 8.1、Windows Server 2012 R2 以降の Windows ストア アプリでサポートされています。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// WS2_32.dll
#include <windows.h>

DWORD htonl(
    DWORD hostlong
);
[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern uint htonl(
    uint hostlong   // DWORD
);
<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function htonl(
    hostlong As UInteger   ' DWORD
) As UInteger
End Function
' hostlong : DWORD
Declare PtrSafe Function htonl Lib "ws2_32" ( _
    ByVal hostlong As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

htonl = ctypes.windll.ws2_32.htonl
htonl.restype = wintypes.DWORD
htonl.argtypes = [
    wintypes.DWORD,  # hostlong : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
htonl = Fiddle::Function.new(
  lib['htonl'],
  [
    -Fiddle::TYPE_INT,  # hostlong : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "ws2_32")]
extern "system" {
    fn htonl(
        hostlong: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WS2_32.dll", SetLastError = true)]
public static extern uint htonl(uint hostlong);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_htonl' -Namespace Win32 -PassThru
# $api::htonl(hostlong)
#uselib "WS2_32.dll"
#func global htonl "htonl" sptr
; htonl hostlong   ; 戻り値は stat
; hostlong : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WS2_32.dll"
#cfunc global htonl "htonl" int
; res = htonl(hostlong)
; hostlong : DWORD -> "int"
; DWORD htonl(DWORD hostlong)
#uselib "WS2_32.dll"
#cfunc global htonl "htonl" int
; res = htonl(hostlong)
; hostlong : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	prochtonl = ws2_32.NewProc("htonl")
)

// hostlong (DWORD)
r1, _, err := prochtonl.Call(
	uintptr(hostlong),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function htonl(
  hostlong: DWORD   // DWORD
): DWORD; stdcall;
  external 'WS2_32.dll' name 'htonl';
result := DllCall("WS2_32\htonl"
    , "UInt", hostlong   ; DWORD
    , "UInt")   ; return: DWORD
●htonl(hostlong) = DLL("WS2_32.dll", "dword htonl(dword)")
# 呼び出し: htonl(hostlong)
# hostlong : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "ws2_32" fn htonl(
    hostlong: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc htonl(
    hostlong: uint32  # DWORD
): uint32 {.importc: "htonl", stdcall, dynlib: "WS2_32.dll".}
pragma(lib, "ws2_32");
extern(Windows)
uint htonl(
    uint hostlong   // DWORD
);
ccall((:htonl, "WS2_32.dll"), stdcall, UInt32,
      (UInt32,),
      hostlong)
# hostlong : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t htonl(
    uint32_t hostlong);
]]
local ws2_32 = ffi.load("ws2_32")
-- ws2_32.htonl(hostlong)
-- hostlong : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WS2_32.dll');
const htonl = lib.func('__stdcall', 'htonl', 'uint32_t', ['uint32_t']);
// htonl(hostlong)
// hostlong : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WS2_32.dll", {
  htonl: { parameters: ["u32"], result: "u32" },
});
// lib.symbols.htonl(hostlong)
// hostlong : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t htonl(
    uint32_t hostlong);
C, "WS2_32.dll");
// $ffi->htonl(hostlong);
// hostlong : DWORD
// 構造体/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 htonl(
        int hostlong   // DWORD
    );
}
@[Link("ws2_32")]
lib LibWS2_32
  fun htonl = htonl(
    hostlong : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef htonlNative = Uint32 Function(Uint32);
typedef htonlDart = int Function(int);
final htonl = DynamicLibrary.open('WS2_32.dll')
    .lookupFunction<htonlNative, htonlDart>('htonl');
// hostlong : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function htonl(
  hostlong: DWORD   // DWORD
): DWORD; stdcall;
  external 'WS2_32.dll' name 'htonl';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "htonl"
  c_htonl :: Word32 -> IO Word32
-- hostlong : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let htonl =
  foreign "htonl"
    (uint32_t @-> returning uint32_t)
(* hostlong : DWORD -> uint32_t *)
(* 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 ("htonl" htonl :convention :stdcall) :uint32
  (hostlong :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $htonl = Win32::API::More->new('WS2_32',
    'DWORD htonl(DWORD hostlong)');
# my $ret = $htonl->Call($hostlong);
# hostlong : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目