ホーム › System.Services › StartServiceCtrlDispatcherW

StartServiceCtrlDispatcherW

関数

サービスのメインスレッドをSCMのディスパッチャに接続する。

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

シグネチャ

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

BOOL StartServiceCtrlDispatcherW(
    const SERVICE_TABLE_ENTRYW* lpServiceStartTable
);

パラメーター

名前	型	方向	説明
lpServiceStartTable	SERVICE_TABLE_ENTRYW*	in	呼び出し元プロセスで実行できる各サービスにつき1エントリを含む SERVICE_TABLE_ENTRY 構造体の配列へのポインターです。テーブルの末尾を示すため、テーブル内の最後のエントリのメンバーは NULL 値である必要があります。

戻り値の型: BOOL

公式ドキュメント

サービスプロセスのメインスレッドをサービスコントロールマネージャーに接続し、そのスレッドを呼び出し元プロセスのサービスコントロールディスパッチャースレッドにします。(Unicode)

戻り値

関数が成功した場合、戻り値は0以外になります。

関数が失敗した場合、戻り値は0になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。

以下のエラーコードはサービスコントロールマネージャーによって設定されることがあります。その他のエラーコードは、サービスコントロールマネージャーが呼び出すレジストリ関数によって設定されることがあります。

戻りコード	説明
ERROR_FAILED_SERVICE_CONTROLLER_CONNECT	このエラーは、プログラムがサービスとしてではなくコンソールアプリケーションとして実行されている場合に返されます。デバッグ目的でプログラムをコンソールアプリケーションとして実行する場合は、このエラーが返されたときにサービス固有のコードが呼び出されないように構成してください。
ERROR_INVALID_DATA	指定されたディスパッチテーブルに、正しい形式でないエントリが含まれています。
ERROR_SERVICE_ALREADY_RUNNING	プロセスは既に StartServiceCtrlDispatcher を呼び出しています。各プロセスは StartServiceCtrlDispatcher を1回のみ呼び出すことができます。

解説(Remarks)

サービスコントロールマネージャーはサービスプロセスを開始すると、そのプロセスが StartServiceCtrlDispatcher 関数を呼び出すのを待ちます。サービスプロセスのメインスレッドは、起動後できるだけ早く(30秒以内に)この呼び出しを行う必要があります。 StartServiceCtrlDispatcher が成功すると、呼び出し元スレッドをサービスコントロールマネージャーに接続し、プロセス内で実行中のすべてのサービスが SERVICE_STOPPED 状態になるまで戻りません。サービスコントロールマネージャーはこの接続を使用して、制御要求およびサービス開始要求をサービスプロセスのメインスレッドに送信します。メインスレッドはディスパッチャーとして動作し、制御要求を処理するために適切な HandlerEx 関数を呼び出すか、新しいサービスが開始されたときに適切な ServiceMain 関数を実行するために新しいスレッドを作成します。

lpServiceTable パラメーターには、呼び出し元プロセスで実行できる各サービスのエントリが含まれます。各エントリは、そのサービスの ServiceMain 関数を指定します。SERVICE_WIN32_SHARE_PROCESS サービスの場合、各エントリにはサービス名を含める必要があります。この名前は、サービスのインストール時に CreateService 関数で指定されたサービス名です。SERVICE_WIN32_OWN_PROCESS サービスの場合、テーブルエントリ内のサービス名は無視されます。

サービスが独自のプロセスで実行される場合、サービスプロセスのメインスレッドは直ちに StartServiceCtrlDispatcher を呼び出す必要があります。すべての初期化タスクは、サービスの開始時にそのサービスの ServiceMain 関数内で行われます。

複数のサービスが1つのプロセスを共有しており、いずれかの ServiceMain 関数が呼び出される前に共通のプロセス全体の初期化を行う必要がある場合、その処理が30秒未満で済むのであれば、メインスレッドが StartServiceCtrlDispatcher を呼び出す前にその作業を行うことができます。そうでない場合は、メインスレッドが StartServiceCtrlDispatcher を呼び出してサービスコントロールディスパッチャーになる一方で、プロセス全体の初期化を行う別のスレッドを作成する必要があります。サービス固有の初期化は、引き続き各サービスのメイン関数内で行う必要があります。

サービスはユーザーインターフェイスを直接表示しようとしてはなりません。詳細については、Interactive Services を参照してください。

例

例については、 Writing a Service Program's Main Function を参照してください。

メモ

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

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

各言語での呼び出し定義

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

BOOL StartServiceCtrlDispatcherW(
    const SERVICE_TABLE_ENTRYW* lpServiceStartTable
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool StartServiceCtrlDispatcherW(
    IntPtr lpServiceStartTable   // SERVICE_TABLE_ENTRYW*
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function StartServiceCtrlDispatcherW(
    lpServiceStartTable As IntPtr   ' SERVICE_TABLE_ENTRYW*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpServiceStartTable : SERVICE_TABLE_ENTRYW*
Declare PtrSafe Function StartServiceCtrlDispatcherW Lib "advapi32" ( _
    ByVal lpServiceStartTable 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

StartServiceCtrlDispatcherW = ctypes.windll.advapi32.StartServiceCtrlDispatcherW
StartServiceCtrlDispatcherW.restype = wintypes.BOOL
StartServiceCtrlDispatcherW.argtypes = [
    ctypes.c_void_p,  # lpServiceStartTable : SERVICE_TABLE_ENTRYW*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
StartServiceCtrlDispatcherW = Fiddle::Function.new(
  lib['StartServiceCtrlDispatcherW'],
  [
    Fiddle::TYPE_VOIDP,  # lpServiceStartTable : SERVICE_TABLE_ENTRYW*
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "advapi32")]
extern "system" {
    fn StartServiceCtrlDispatcherW(
        lpServiceStartTable: *const SERVICE_TABLE_ENTRYW  // SERVICE_TABLE_ENTRYW*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool StartServiceCtrlDispatcherW(IntPtr lpServiceStartTable);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_StartServiceCtrlDispatcherW' -Namespace Win32 -PassThru
# $api::StartServiceCtrlDispatcherW(lpServiceStartTable)

#uselib "ADVAPI32.dll"
#func global StartServiceCtrlDispatcherW "StartServiceCtrlDispatcherW" wptr
; StartServiceCtrlDispatcherW varptr(lpServiceStartTable)   ; 戻り値は stat
; lpServiceStartTable : SERVICE_TABLE_ENTRYW* -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global StartServiceCtrlDispatcherW "StartServiceCtrlDispatcherW" var
; res = StartServiceCtrlDispatcherW(lpServiceStartTable)
; lpServiceStartTable : SERVICE_TABLE_ENTRYW* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global StartServiceCtrlDispatcherW "StartServiceCtrlDispatcherW" sptr
; res = StartServiceCtrlDispatcherW(varptr(lpServiceStartTable))
; lpServiceStartTable : SERVICE_TABLE_ENTRYW* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。