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

ntohl

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

シグネチャ

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

DWORD ntohl(
    DWORD netlong
);

パラメーター

名前方向説明
netlongDWORDinTCP/IP のネットワーク バイト オーダーの 32 ビットの数値です。

戻り値の型: DWORD

公式ドキュメント

ntohl 関数 (winsock.h) は、u_long を TCP/IP のネットワーク バイト オーダーから、ホスト バイト オーダー(Intel プロセッサ上ではリトル エンディアン)へ変換します。

戻り値

ntohl 関数は、netlong パラメーターで指定された値のバイト オーダーを反転して返します。netlong が既にホスト バイト オーダーである場合、この関数はそれを反転します。バイト オーダーの反転が必要かどうかを判断するのは、アプリケーションの責任です。

解説(Remarks)

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

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

ntohl 関数は、事前に 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 ntohl(
    DWORD netlong
);
[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern uint ntohl(
    uint netlong   // DWORD
);
<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ntohl(
    netlong As UInteger   ' DWORD
) As UInteger
End Function
' netlong : DWORD
Declare PtrSafe Function ntohl Lib "ws2_32" ( _
    ByVal netlong As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procntohl = ws2_32.NewProc("ntohl")
)

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

extern "ws2_32" fn ntohl(
    netlong: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc ntohl(
    netlong: uint32  # DWORD
): uint32 {.importc: "ntohl", stdcall, dynlib: "WS2_32.dll".}
pragma(lib, "ws2_32");
extern(Windows)
uint ntohl(
    uint netlong   // DWORD
);
ccall((:ntohl, "WS2_32.dll"), stdcall, UInt32,
      (UInt32,),
      netlong)
# netlong : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t ntohl(
    uint32_t netlong);
]]
local ws2_32 = ffi.load("ws2_32")
-- ws2_32.ntohl(netlong)
-- netlong : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WS2_32.dll');
const ntohl = lib.func('__stdcall', 'ntohl', 'uint32_t', ['uint32_t']);
// ntohl(netlong)
// netlong : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WS2_32.dll", {
  ntohl: { parameters: ["u32"], result: "u32" },
});
// lib.symbols.ntohl(netlong)
// netlong : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t ntohl(
    uint32_t netlong);
C, "WS2_32.dll");
// $ffi->ntohl(netlong);
// netlong : 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 ntohl(
        int netlong   // DWORD
    );
}
@[Link("ws2_32")]
lib LibWS2_32
  fun ntohl = ntohl(
    netlong : 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 ntohlNative = Uint32 Function(Uint32);
typedef ntohlDart = int Function(int);
final ntohl = DynamicLibrary.open('WS2_32.dll')
    .lookupFunction<ntohlNative, ntohlDart>('ntohl');
// netlong : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ntohl(
  netlong: DWORD   // DWORD
): DWORD; stdcall;
  external 'WS2_32.dll' name 'ntohl';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

関連項目

公式の関連項目