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

getprotobyname

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

シグネチャ

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

PROTOENT* getprotobyname(
    LPCSTR name
);

パラメーター

名前方向説明
nameLPCSTRinnull 終端されたプロトコル名へのポインター。

戻り値の型: PROTOENT*

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

getprotobyname 関数は、name パラメーターで指定されたプロトコルに対応する名前とプロトコル番号を含む protoent 構造体へのポインターを返します。すべての文字列は null 終端されています。 protoent 構造体は Windows Sockets ライブラリによって割り当てられます。アプリケーションは、この構造体を変更したり、その構成要素のいずれかを解放したりしようとしてはなりません。さらに、 hostent と同様に、この構造体はスレッドごとに 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* getprotobyname(
    LPCSTR name
);
[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr getprotobyname(
    [MarshalAs(UnmanagedType.LPStr)] string name   // LPCSTR
);
<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function getprotobyname(
    <MarshalAs(UnmanagedType.LPStr)> name As String   ' LPCSTR
) As IntPtr
End Function
' name : LPCSTR
Declare PtrSafe Function getprotobyname Lib "ws2_32" ( _
    ByVal name As String) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

getprotobyname = ctypes.windll.ws2_32.getprotobyname
getprotobyname.restype = ctypes.c_void_p
getprotobyname.argtypes = [
    wintypes.LPCSTR,  # name : LPCSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procgetprotobyname = ws2_32.NewProc("getprotobyname")
)

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

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

typedef getprotobynameNative = Pointer<Void> Function(Pointer<Utf8>);
typedef getprotobynameDart = Pointer<Void> Function(Pointer<Utf8>);
final getprotobyname = DynamicLibrary.open('WS2_32.dll')
    .lookupFunction<getprotobynameNative, getprotobynameDart>('getprotobyname');
// name : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function getprotobyname(
  name: PAnsiChar   // LPCSTR
): Pointer; stdcall;
  external 'WS2_32.dll' name 'getprotobyname';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

関連項目

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