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

getprotobynumber

関数
プロトコル番号に対応するプロトコル情報を取得する。
DLLWS2_32.dll呼出規約winapiSetLastErrorあり対応OSWindows 8.1 以降

シグネチャ

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

PROTOENT* getprotobynumber(
    INT number
);

パラメーター

名前方向説明
numberINTin検索対象のプロトコル番号をホストバイトオーダーで指定する(例6=TCP、17=UDP)。

戻り値の型: PROTOENT*

公式ドキュメント

getprotobynumber 関数 (winsock.h) は、プロトコル番号に対応するプロトコル情報を取得します。

戻り値

エラーが発生しなかった場合、 getprotobynumberprotoent 構造体へのポインターを返します。それ以外の場合は null ポインターを返し、 WSAGetLastError を呼び出すことで具体的なエラー番号を取得できます。

エラーコード 意味
WSANOTINITIALISED
この関数を使用する前に、 WSAStartup の呼び出しが成功している必要があります。
WSAENETDOWN
ネットワークサブシステムが失敗しました。
WSAHOST_NOT_FOUND
権威ある応答でプロトコルが見つかりませんでした。
WSATRY_AGAIN
非権威的な応答でプロトコルが見つからなかったか、サーバーの障害です。
WSANO_RECOVERY
回復不能なエラーです。プロトコルデータベースにアクセスできません。
WSANO_DATA
名前は有効ですが、要求された種類のデータレコードがありません。
WSAEINPROGRESS
ブロッキング型の Windows Sockets 1.1 呼び出しが進行中であるか、サービスプロバイダーがコールバック関数をまだ処理しています。
WSAEINTR
ブロッキング型の Windows Socket 1.1 呼び出しが WSACancelBlockingCall によってキャンセルされました。

解説(Remarks)

この getprotobynumber 関数は、 getprotobyname で前述したとおり、 protoent 構造体へのポインターを返します。この構造体の内容は、指定されたプロトコル番号に対応します。

返されるポインターは、Windows Sockets によって割り当てられた構造体を指します。アプリケーションは、この構造体を変更したり、そのコンポーネントを解放したりしてはなりません。さらに、この構造体はスレッドごとに 1 つのコピーのみが割り当てられるため、アプリケーションは他の Windows Sockets 関数を呼び出す前に、必要な情報をコピーしておく必要があります。

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>

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

getprotobynumber = ctypes.windll.ws2_32.getprotobynumber
getprotobynumber.restype = ctypes.c_void_p
getprotobynumber.argtypes = [
    ctypes.c_int,  # number : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procgetprotobynumber = ws2_32.NewProc("getprotobynumber")
)

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

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

typedef getprotobynumberNative = Pointer<Void> Function(Int32);
typedef getprotobynumberDart = Pointer<Void> Function(int);
final getprotobynumber = DynamicLibrary.open('WS2_32.dll')
    .lookupFunction<getprotobynumberNative, getprotobynumberDart>('getprotobynumber');
// number : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function getprotobynumber(
  number: Integer   // INT
): Pointer; stdcall;
  external 'WS2_32.dll' name 'getprotobynumber';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "getprotobynumber"
  c_getprotobynumber :: Int32 -> IO (Ptr ())
-- number : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

関連項目

公式の関連項目
使用する型