GetServiceA

関数

登録済みサービスのプロパティ情報を取得する。

DLLMSWSOCK.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// MSWSOCK.dll  (ANSI / -A)
#include <windows.h>

INT GetServiceA(
    DWORD dwNameSpace,
    GUID* lpGuid,
    LPSTR lpServiceName,
    DWORD dwProperties,
    void* lpBuffer,
    DWORD* lpdwBufferSize,
    SERVICE_ASYNC_INFO* lpServiceAsyncInfo   // optional
);

パラメーター

名前

型

方向

説明

dwNameSpace

DWORD

指定されたネットワークサービスに関する情報について、オペレーティングシステムが照会する名前空間、または既定の名前空間のセットです。

名前空間を指定するには、次の定数のいずれかを使用します。

値	意味
NS_DEFAULT	既定の名前空間のセットです。オペレーティングシステムは、このセット内の各名前空間を照会します。既定の名前空間のセットには通常、システムにインストールされているすべての名前空間が含まれます。ただし、システム管理者は特定の名前空間をセットから除外できます。NS_DEFAULT は、ほとんどのアプリケーションが dwNameSpace に使用すべき値です。
NS_DNS	インターネットでホスト名解決に使用される Domain Name System です。
NS_NETBT	NetBIOS over TCP/IP レイヤーです。すべてのオペレーティングシステムは、コンピューター名を NetBIOS に登録します。この名前空間は、この登録を使用してコンピューター名を IP アドレスに解決するために使用されます。NS_NETBT は、解決を実行するために WINS サーバーにアクセスできることに注意してください。
NS_SAP	NetWare Service Advertising Protocol です。必要に応じて NetWare バインダリにアクセスできます。NS_SAP は、サービスの登録を可能にする動的な名前空間です。
NS_TCPIP_HOSTS	<systemroot>\system32\drivers\etc\hosts ファイル内のホスト名と IP アドレスを検索します。
NS_TCPIP_LOCAL	ローカルホスト名との比較を含むローカルの TCP/IP 名前解決メカニズムであり、ホストから IP アドレスへのマッピングのキャッシュ内でホスト名と IP アドレスを検索します。

GetService へのほとんどの呼び出しでは、特別な値 NS_DEFAULT を使用すべきです。これにより、クライアントはインターネットワーク上で利用可能な名前空間を知らなくても処理を行えます。名前空間へのアクセスはシステム管理者が決定します。名前空間は、クライアントが変更を意識する必要なく、追加されたり削除されたりします。

lpGuid

GUID*

ネットワークサービスの種類を指定するグローバル一意識別子 (GUID) へのポインターです。Svcguid.h ヘッダーファイルには、DNS および SAP 名前空間内の多くのよく知られたサービスの GUID サービスタイプが含まれています。

Svcguid.h ヘッダーファイルは、Winsock2.h ヘッダーファイルによって自動的にインクルードされません。

lpServiceName

LPSTR

サービス名を一意に表すゼロ終端文字列へのポインターです。たとえば「MY SNA SERVER」です。

dwProperties

DWORD

関数が取得するサービス情報を指定するビットフラグのセットです。これらのビットフラグ定数は、PROP_ALL 以外はそれぞれ SERVICE_INFO データ構造体の特定のメンバーに対応します。フラグが設定されている場合、関数は *lpBuffer に格納されたデータ構造体の対応するメンバーに情報を格納します。次のビットフラグが定義されています。

値	意味
PROP_COMMENT	このフラグが設定されている場合、関数は *lpBuffer に格納されたデータ構造体の lpComment メンバーにデータを格納します。
PROP_LOCALE	このフラグが設定されている場合、関数は *lpBuffer に格納されたデータ構造体の lpLocale メンバーにデータを格納します。
PROP_DISPLAY_HINT	このフラグが設定されている場合、関数は *lpBuffer に格納されたデータ構造体の dwDisplayHint メンバーにデータを格納します。
PROP_VERSION	このフラグが設定されている場合、関数は *lpBuffer に格納されたデータ構造体の dwVersion メンバーにデータを格納します。
PROP_START_TIME	このフラグが設定されている場合、関数は *lpBuffer に格納されたデータ構造体の dwTime メンバーにデータを格納します。
PROP_MACHINE	このフラグが設定されている場合、関数は *lpBuffer に格納されたデータ構造体の lpMachineName メンバーにデータを格納します。
PROP_ADDRESSES	このフラグが設定されている場合、関数は *lpBuffer に格納されたデータ構造体の lpServiceAddress メンバーにデータを格納します。
PROP_SD	このフラグが設定されている場合、関数は *lpBuffer に格納されたデータ構造体の ServiceSpecificInfo メンバーにデータを格納します。
PROP_ALL	このフラグが設定されている場合、関数は *lpBuffer に格納されたデータ構造体のすべてのメンバーにデータを格納します。

lpBuffer

void*

out

NS_SERVICE_INFO 構造体の配列と関連するサービス情報を受け取るバッファーへのポインターです。各 NS_SERVICE_INFO 構造体には、特定の名前空間のコンテキストにおけるサービス情報が含まれます。dwNameSpace が NS_DEFAULT の場合、関数はバッファーに複数の構造体を格納します。それ以外の場合は 1 つの構造体のみが格納されることに注意してください。

各 NS_SERVICE_INFO 構造体には、 SERVICE_INFO 構造体が含まれます。これらの SERVICE_INFO 構造体のメンバーには、dwProperties パラメーターに設定されたビットフラグに基づいて有効なデータが含まれます。メンバーに対応するビットフラグが dwProperties に設定されていない場合、そのメンバーの値は未定義です。

関数は、バッファーの先頭から始まる連続した配列として NS_SERVICE_INFO 構造体を格納します。含まれる SERVICE_INFO 構造体内のポインターは、 NS_SERVICE_INFO 構造体の末尾とバッファーの末尾の間に格納された情報を指します。

lpdwBufferSize

DWORD*

inout

入力時に lpBuffer が指すバッファーのサイズ (バイト単位) を格納する変数へのポインターです。出力時には、要求された情報を格納するために必要なバイト数がこの変数に格納されます。この出力値が入力値より大きい場合、バッファーサイズが不足しているため関数は失敗しています。

lpServiceAsyncInfo

SERVICE_ASYNC_INFO*

inoptional

将来の使用のために予約されています。NULL に設定する必要があります。

戻り値の型: INT

公式ドキュメント

GetService 関数は、既定の名前空間のセット、または指定された名前空間のコンテキストで、ネットワークサービスに関する情報を取得します。(ANSI)

戻り値

関数が成功した場合、戻り値は *lpBuffer に格納された NS_SERVICE_INFO 構造体の数です。0 は、構造体が格納されなかったことを示します。

関数が失敗した場合、戻り値は SOCKET_ERROR (–1) です。拡張エラー情報を取得するには GetLastError を呼び出します。この関数は、次の拡張エラー値のいずれかを返します。

エラーコード	意味
ERROR_INSUFFICIENT_BUFFER	lpBuffer が指すバッファーが小さすぎて、要求されたすべての情報を受け取れません。*lpdwBufferSize に返された値以上のサイズのバッファーで関数を呼び出してください。
ERROR_SERVICE_NOT_FOUND	指定されたサービスが見つからなかったか、指定された名前空間が使用されていません。この場合、関数の戻り値は 0 です。

解説(Remarks)

メモ

nspapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして GetService を定義しています。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不整合が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// MSWSOCK.dll  (ANSI / -A)
#include <windows.h>

INT GetServiceA(
    DWORD dwNameSpace,
    GUID* lpGuid,
    LPSTR lpServiceName,
    DWORD dwProperties,
    void* lpBuffer,
    DWORD* lpdwBufferSize,
    SERVICE_ASYNC_INFO* lpServiceAsyncInfo   // optional
);

[DllImport("MSWSOCK.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern int GetServiceA(
    uint dwNameSpace,   // DWORD
    ref Guid lpGuid,   // GUID*
    [MarshalAs(UnmanagedType.LPStr)] string lpServiceName,   // LPSTR
    uint dwProperties,   // DWORD
    IntPtr lpBuffer,   // void* out
    ref uint lpdwBufferSize,   // DWORD* in/out
    IntPtr lpServiceAsyncInfo   // SERVICE_ASYNC_INFO* optional
);

<DllImport("MSWSOCK.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetServiceA(
    dwNameSpace As UInteger,   ' DWORD
    ByRef lpGuid As Guid,   ' GUID*
    <MarshalAs(UnmanagedType.LPStr)> lpServiceName As String,   ' LPSTR
    dwProperties As UInteger,   ' DWORD
    lpBuffer As IntPtr,   ' void* out
    ByRef lpdwBufferSize As UInteger,   ' DWORD* in/out
    lpServiceAsyncInfo As IntPtr   ' SERVICE_ASYNC_INFO* optional
) As Integer
End Function

' dwNameSpace : DWORD
' lpGuid : GUID*
' lpServiceName : LPSTR
' dwProperties : DWORD
' lpBuffer : void* out
' lpdwBufferSize : DWORD* in/out
' lpServiceAsyncInfo : SERVICE_ASYNC_INFO* optional
Declare PtrSafe Function GetServiceA Lib "mswsock" ( _
    ByVal dwNameSpace As Long, _
    ByVal lpGuid As LongPtr, _
    ByVal lpServiceName As String, _
    ByVal dwProperties As Long, _
    ByVal lpBuffer As LongPtr, _
    ByRef lpdwBufferSize As Long, _
    ByVal lpServiceAsyncInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetServiceA = ctypes.windll.mswsock.GetServiceA
GetServiceA.restype = ctypes.c_int
GetServiceA.argtypes = [
    wintypes.DWORD,  # dwNameSpace : DWORD
    ctypes.c_void_p,  # lpGuid : GUID*
    wintypes.LPCSTR,  # lpServiceName : LPSTR
    wintypes.DWORD,  # dwProperties : DWORD
    ctypes.POINTER(None),  # lpBuffer : void* out
    ctypes.POINTER(wintypes.DWORD),  # lpdwBufferSize : DWORD* in/out
    ctypes.c_void_p,  # lpServiceAsyncInfo : SERVICE_ASYNC_INFO* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MSWSOCK.dll')
GetServiceA = Fiddle::Function.new(
  lib['GetServiceA'],
  [
    -Fiddle::TYPE_INT,  # dwNameSpace : DWORD
    Fiddle::TYPE_VOIDP,  # lpGuid : GUID*
    Fiddle::TYPE_VOIDP,  # lpServiceName : LPSTR
    -Fiddle::TYPE_INT,  # dwProperties : DWORD
    Fiddle::TYPE_VOIDP,  # lpBuffer : void* out
    Fiddle::TYPE_VOIDP,  # lpdwBufferSize : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lpServiceAsyncInfo : SERVICE_ASYNC_INFO* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "mswsock")]
extern "system" {
    fn GetServiceA(
        dwNameSpace: u32,  // DWORD
        lpGuid: *mut GUID,  // GUID*
        lpServiceName: *mut u8,  // LPSTR
        dwProperties: u32,  // DWORD
        lpBuffer: *mut (),  // void* out
        lpdwBufferSize: *mut u32,  // DWORD* in/out
        lpServiceAsyncInfo: *mut SERVICE_ASYNC_INFO  // SERVICE_ASYNC_INFO* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("MSWSOCK.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern int GetServiceA(uint dwNameSpace, ref Guid lpGuid, [MarshalAs(UnmanagedType.LPStr)] string lpServiceName, uint dwProperties, IntPtr lpBuffer, ref uint lpdwBufferSize, IntPtr lpServiceAsyncInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MSWSOCK_GetServiceA' -Namespace Win32 -PassThru
# $api::GetServiceA(dwNameSpace, lpGuid, lpServiceName, dwProperties, lpBuffer, lpdwBufferSize, lpServiceAsyncInfo)

#uselib "MSWSOCK.dll"
#func global GetServiceA "GetServiceA" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; GetServiceA dwNameSpace, varptr(lpGuid), lpServiceName, dwProperties, lpBuffer, varptr(lpdwBufferSize), varptr(lpServiceAsyncInfo)   ; 戻り値は stat
; dwNameSpace : DWORD -> "sptr"
; lpGuid : GUID* -> "sptr"
; lpServiceName : LPSTR -> "sptr"
; dwProperties : DWORD -> "sptr"
; lpBuffer : void* out -> "sptr"
; lpdwBufferSize : DWORD* in/out -> "sptr"
; lpServiceAsyncInfo : SERVICE_ASYNC_INFO* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "MSWSOCK.dll"
#cfunc global GetServiceA "GetServiceA" int, var, str, int, sptr, var, var
; res = GetServiceA(dwNameSpace, lpGuid, lpServiceName, dwProperties, lpBuffer, lpdwBufferSize, lpServiceAsyncInfo)
; dwNameSpace : DWORD -> "int"
; lpGuid : GUID* -> "var"
; lpServiceName : LPSTR -> "str"
; dwProperties : DWORD -> "int"
; lpBuffer : void* out -> "sptr"
; lpdwBufferSize : DWORD* in/out -> "var"
; lpServiceAsyncInfo : SERVICE_ASYNC_INFO* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "MSWSOCK.dll"
#cfunc global GetServiceA "GetServiceA" int, sptr, str, int, sptr, sptr, sptr
; res = GetServiceA(dwNameSpace, varptr(lpGuid), lpServiceName, dwProperties, lpBuffer, varptr(lpdwBufferSize), varptr(lpServiceAsyncInfo))
; dwNameSpace : DWORD -> "int"
; lpGuid : GUID* -> "sptr"
; lpServiceName : LPSTR -> "str"
; dwProperties : DWORD -> "int"
; lpBuffer : void* out -> "sptr"
; lpdwBufferSize : DWORD* in/out -> "sptr"
; lpServiceAsyncInfo : SERVICE_ASYNC_INFO* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。