GetServiceW

関数

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

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

シグネチャ

// MSWSOCK.dll  (Unicode / -W)
#include <windows.h>

INT GetServiceW(
    DWORD dwNameSpace,
    GUID* lpGuid,
    LPWSTR 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 bindery にアクセスできます。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

LPWSTR

サービス名を一意に表す、ゼロ終端文字列へのポインターです。例: "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 関数は、デフォルトのネームスペースの集合、または指定されたネームスペースのコンテキストにおいて、ネットワークサービスに関する情報を取得します。(Unicode)

戻り値

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

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

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

解説(Remarks)

メモ

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

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

各言語での呼び出し定義

// MSWSOCK.dll  (Unicode / -W)
#include <windows.h>

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

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

<DllImport("MSWSOCK.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetServiceW(
    dwNameSpace As UInteger,   ' DWORD
    ByRef lpGuid As Guid,   ' GUID*
    <MarshalAs(UnmanagedType.LPWStr)> lpServiceName As String,   ' LPWSTR
    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 : LPWSTR
' dwProperties : DWORD
' lpBuffer : void* out
' lpdwBufferSize : DWORD* in/out
' lpServiceAsyncInfo : SERVICE_ASYNC_INFO* optional
Declare PtrSafe Function GetServiceW Lib "mswsock" ( _
    ByVal dwNameSpace As Long, _
    ByVal lpGuid As LongPtr, _
    ByVal lpServiceName As LongPtr, _
    ByVal dwProperties As Long, _
    ByVal lpBuffer As LongPtr, _
    ByRef lpdwBufferSize As Long, _
    ByVal lpServiceAsyncInfo As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetServiceW = ctypes.windll.mswsock.GetServiceW
GetServiceW.restype = ctypes.c_int
GetServiceW.argtypes = [
    wintypes.DWORD,  # dwNameSpace : DWORD
    ctypes.c_void_p,  # lpGuid : GUID*
    wintypes.LPCWSTR,  # lpServiceName : LPWSTR
    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')
GetServiceW = Fiddle::Function.new(
  lib['GetServiceW'],
  [
    -Fiddle::TYPE_INT,  # dwNameSpace : DWORD
    Fiddle::TYPE_VOIDP,  # lpGuid : GUID*
    Fiddle::TYPE_VOIDP,  # lpServiceName : LPWSTR
    -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)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "mswsock")]
extern "system" {
    fn GetServiceW(
        dwNameSpace: u32,  // DWORD
        lpGuid: *mut GUID,  // GUID*
        lpServiceName: *mut u16,  // LPWSTR
        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.Unicode, SetLastError = true)]
public static extern int GetServiceW(uint dwNameSpace, ref Guid lpGuid, [MarshalAs(UnmanagedType.LPWStr)] string lpServiceName, uint dwProperties, IntPtr lpBuffer, ref uint lpdwBufferSize, IntPtr lpServiceAsyncInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MSWSOCK_GetServiceW' -Namespace Win32 -PassThru
# $api::GetServiceW(dwNameSpace, lpGuid, lpServiceName, dwProperties, lpBuffer, lpdwBufferSize, lpServiceAsyncInfo)

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

出力引数:

#uselib "MSWSOCK.dll"
#cfunc global GetServiceW "GetServiceW" int, var, wstr, int, sptr, var, var
; res = GetServiceW(dwNameSpace, lpGuid, lpServiceName, dwProperties, lpBuffer, lpdwBufferSize, lpServiceAsyncInfo)
; dwNameSpace : DWORD -> "int"
; lpGuid : GUID* -> "var"
; lpServiceName : LPWSTR -> "wstr"
; 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 GetServiceW "GetServiceW" int, sptr, wstr, int, sptr, sptr, sptr
; res = GetServiceW(dwNameSpace, varptr(lpGuid), lpServiceName, dwProperties, lpBuffer, varptr(lpdwBufferSize), varptr(lpServiceAsyncInfo))
; dwNameSpace : DWORD -> "int"
; lpGuid : GUID* -> "sptr"
; lpServiceName : LPWSTR -> "wstr"
; dwProperties : DWORD -> "int"
; lpBuffer : void* out -> "sptr"
; lpdwBufferSize : DWORD* in/out -> "sptr"
; lpServiceAsyncInfo : SERVICE_ASYNC_INFO* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。