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

htons

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

シグネチャ

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

WORD htons(
    WORD hostshort
);

パラメーター

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

戻り値の型: WORD

公式ドキュメント

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

戻り値

htons 関数は、TCP/IP ネットワークバイトオーダーでの値を返します。

解説(Remarks)

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

htons 関数は、ホストバイトオーダーの IP ポート番号を、ネットワークバイトオーダーの IP ポート番号に変換するために使用できます。

htons 関数は、事前に 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>

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

htons = ctypes.windll.ws2_32.htons
htons.restype = ctypes.c_ushort
htons.argtypes = [
    ctypes.c_ushort,  # hostshort : WORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	prochtons = ws2_32.NewProc("htons")
)

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

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

typedef htonsNative = Uint16 Function(Uint16);
typedef htonsDart = int Function(int);
final htons = DynamicLibrary.open('WS2_32.dll')
    .lookupFunction<htonsNative, htonsDart>('htons');
// hostshort : WORD -> Uint16
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function htons(
  hostshort: Word   // WORD
): Word; stdcall;
  external 'WS2_32.dll' name 'htons';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

関連項目

公式の関連項目