WSANtohs

関数

16ビット値をネットワーク順からホストバイト順へ変換する。

DLLWS2_32.dll呼出規約winapiSetLastErrorあり対応OSWindows 8.1 以降

シグネチャ

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

INT WSANtohs(
    SOCKET s,
    WORD netshort,
    WORD* lphostshort
);

パラメーター

名前	型	方向	説明
s	SOCKET	in	socket を識別する記述子。
netshort	WORD	in	ネットワークバイトオーダーの 16 ビットの数値。
lphostshort	WORD*	out	ホストバイトオーダーの数値を受け取る 16 ビットの数値へのポインター。

戻り値の型: INT

公式ドキュメント

WSANtohs 関数は、u_short をネットワークバイトオーダーからホストバイトオーダーに変換します。

戻り値

エラーが発生しない場合、 WSANtohs はゼロを返します。それ以外の場合は SOCKET_ERROR の値が返され、 WSAGetLastError を呼び出すことで特定のエラーコードを取得できます。

エラーコード	意味
WSANOTINITIALISED	この関数を使用する前に、 WSAStartup の呼び出しが成功している必要があります。
WSAENETDOWN	ネットワークサブシステムが失敗しました。
WSAENOTSOCK	記述子が socket ではありません。
WSAEFAULT	lphostshort パラメーターが NULL であるか、ポインターが指すアドレスがユーザーアドレス空間の有効な部分に完全に含まれていません。

解説(Remarks)

WSANtohs 関数は、ネットワークバイトオーダーの 16 ビットの数値を受け取り、lphostshort パラメーターが指す 16 ビットの数値に、ホストバイトオーダーの 16 ビットの数値を返します。s パラメーターに渡された socket は、その socket に関連付けられた Winsock カタログのプロトコルエントリに基づいて、必要なネットワークバイトオーダーを判定するために使用されます。この機能は、異なるネットワークバイトオーダーを使用する Winsock プロバイダーをサポートします。

socket が AF_INET または AF_INET6 アドレスファミリのものである場合、 WSANtohs 関数を使用して、ネットワークバイトオーダーの IP ポート番号をホストバイトオーダーの IP ポート番号に変換できます。

WSANtohs 関数では、WSAStartup 関数の呼び出しが成功し、事前に Winsock DLL が読み込まれている必要があります。AF_INET または AF_INET6 アドレスファミリで使用する場合、ntohs 関数は Winsock DLL が読み込まれていることを必要としません。

Windows Phone 8: この関数は、Windows Phone 8 以降の Windows Phone ストアアプリでサポートされています。

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>

INT WSANtohs(
    SOCKET s,
    WORD netshort,
    WORD* lphostshort
);

[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern int WSANtohs(
    UIntPtr s,   // SOCKET
    ushort netshort,   // WORD
    out ushort lphostshort   // WORD* out
);

<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSANtohs(
    s As UIntPtr,   ' SOCKET
    netshort As UShort,   ' WORD
    <Out> ByRef lphostshort As UShort   ' WORD* out
) As Integer
End Function

' s : SOCKET
' netshort : WORD
' lphostshort : WORD* out
Declare PtrSafe Function WSANtohs Lib "ws2_32" ( _
    ByVal s As LongPtr, _
    ByVal netshort As Integer, _
    ByRef lphostshort As Integer) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WSANtohs = ctypes.windll.ws2_32.WSANtohs
WSANtohs.restype = ctypes.c_int
WSANtohs.argtypes = [
    ctypes.c_size_t,  # s : SOCKET
    ctypes.c_ushort,  # netshort : WORD
    ctypes.POINTER(ctypes.c_ushort),  # lphostshort : WORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
WSANtohs = Fiddle::Function.new(
  lib['WSANtohs'],
  [
    Fiddle::TYPE_UINTPTR_T,  # s : SOCKET
    -Fiddle::TYPE_SHORT,  # netshort : WORD
    Fiddle::TYPE_VOIDP,  # lphostshort : WORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ws2_32")]
extern "system" {
    fn WSANtohs(
        s: usize,  // SOCKET
        netshort: u16,  // WORD
        lphostshort: *mut u16  // WORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WS2_32.dll", SetLastError = true)]
public static extern int WSANtohs(UIntPtr s, ushort netshort, out ushort lphostshort);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSANtohs' -Namespace Win32 -PassThru
# $api::WSANtohs(s, netshort, lphostshort)

#uselib "WS2_32.dll"
#func global WSANtohs "WSANtohs" sptr, sptr, sptr
; WSANtohs s, netshort, varptr(lphostshort)   ; 戻り値は stat
; s : SOCKET -> "sptr"
; netshort : WORD -> "sptr"
; lphostshort : WORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WS2_32.dll"
#cfunc global WSANtohs "WSANtohs" sptr, int, var
; res = WSANtohs(s, netshort, lphostshort)
; s : SOCKET -> "sptr"
; netshort : WORD -> "int"
; lphostshort : WORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WS2_32.dll"
#cfunc global WSANtohs "WSANtohs" sptr, int, sptr
; res = WSANtohs(s, netshort, varptr(lphostshort))
; s : SOCKET -> "sptr"
; netshort : WORD -> "int"
; lphostshort : WORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。