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

getservbyname

関数
サービス名に対応するサービス情報を取得する。
DLLWS2_32.dll呼出規約winapiSetLastErrorあり対応OSWindows 8.1 以降

シグネチャ

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

SERVENT* getservbyname(
    LPCSTR name,
    LPCSTR proto   // optional
);

パラメーター

名前方向説明
nameLPCSTRinnull 終端のサービス名へのポインター。
protoLPCSTRinoptionalnull 終端のプロトコル名へのポインター。このポインターが NULL の場合、 getservbyname 関数は、nameservent 構造体の s_name メンバーまたは servent 構造体の s_aliases メンバーと一致する最初のサービス エントリを返します。それ以外の場合、 getservbynamenameproto の両方を照合します。

戻り値の型: SERVENT*

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

getservbyname 関数は、name パラメーターの文字列と一致する名前およびサービス番号を含む servent 構造体へのポインターを返します。すべての文字列は null 終端です。

返されるポインターは、Windows Sockets ライブラリによって割り当てられた servent 構造体を指します。アプリケーションは、この構造体を変更したり、そのコンポーネントを解放したりしようとしてはなりません。さらに、この構造体はスレッドごとに 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>

SERVENT* getservbyname(
    LPCSTR name,
    LPCSTR proto   // optional
);
[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr getservbyname(
    [MarshalAs(UnmanagedType.LPStr)] string name,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string proto   // LPCSTR optional
);
<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function getservbyname(
    <MarshalAs(UnmanagedType.LPStr)> name As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> proto As String   ' LPCSTR optional
) As IntPtr
End Function
' name : LPCSTR
' proto : LPCSTR optional
Declare PtrSafe Function getservbyname Lib "ws2_32" ( _
    ByVal name As String, _
    ByVal proto As String) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procgetservbyname = ws2_32.NewProc("getservbyname")
)

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

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

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

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

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

関連項目

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