Win32 API 日本語リファレンス
ホームSystem.Services › StartServiceCtrlDispatcherA

StartServiceCtrlDispatcherA

関数
サービスのメインスレッドをSCMのディスパッチャに接続する。
DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL StartServiceCtrlDispatcherA(
    const SERVICE_TABLE_ENTRYA* lpServiceStartTable
);

パラメーター

名前方向説明
lpServiceStartTableSERVICE_TABLE_ENTRYA*inSERVICE_TABLE_ENTRY 構造体の配列へのポインターです。呼び出し元プロセス内で実行できる各サービスにつき 1 つのエントリを含みます。テーブルの末尾を示すため、最後のエントリのメンバーは NULL 値でなければなりません。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は 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 関数が呼び出される前にプロセス全体に共通する初期化を行う必要がある場合、メインスレッドは StartServiceCtrlDispatcher を呼び出す前にその処理を実行できます(ただし 30 秒未満で完了する場合に限ります)。それ以外の場合は、プロセス全体の初期化を行う別のスレッドを作成し、メインスレッドは StartServiceCtrlDispatcher を呼び出してサービスコントロールディスパッチャーになる必要があります。サービス固有の初期化は、引き続き個々のサービスメイン関数内で行う必要があります。

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

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

メモ

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

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

各言語での呼び出し定義

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

BOOL StartServiceCtrlDispatcherA(
    const SERVICE_TABLE_ENTRYA* lpServiceStartTable
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool StartServiceCtrlDispatcherA(
    IntPtr lpServiceStartTable   // SERVICE_TABLE_ENTRYA*
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function StartServiceCtrlDispatcherA(
    lpServiceStartTable As IntPtr   ' SERVICE_TABLE_ENTRYA*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpServiceStartTable : SERVICE_TABLE_ENTRYA*
Declare PtrSafe Function StartServiceCtrlDispatcherA Lib "advapi32" ( _
    ByVal lpServiceStartTable As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

StartServiceCtrlDispatcherA = ctypes.windll.advapi32.StartServiceCtrlDispatcherA
StartServiceCtrlDispatcherA.restype = wintypes.BOOL
StartServiceCtrlDispatcherA.argtypes = [
    ctypes.c_void_p,  # lpServiceStartTable : SERVICE_TABLE_ENTRYA*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
StartServiceCtrlDispatcherA = Fiddle::Function.new(
  lib['StartServiceCtrlDispatcherA'],
  [
    Fiddle::TYPE_VOIDP,  # lpServiceStartTable : SERVICE_TABLE_ENTRYA*
  ],
  Fiddle::TYPE_INT)
#[link(name = "advapi32")]
extern "system" {
    fn StartServiceCtrlDispatcherA(
        lpServiceStartTable: *const SERVICE_TABLE_ENTRYA  // SERVICE_TABLE_ENTRYA*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool StartServiceCtrlDispatcherA(IntPtr lpServiceStartTable);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_StartServiceCtrlDispatcherA' -Namespace Win32 -PassThru
# $api::StartServiceCtrlDispatcherA(lpServiceStartTable)
#uselib "ADVAPI32.dll"
#func global StartServiceCtrlDispatcherA "StartServiceCtrlDispatcherA" sptr
; StartServiceCtrlDispatcherA varptr(lpServiceStartTable)   ; 戻り値は stat
; lpServiceStartTable : SERVICE_TABLE_ENTRYA* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ADVAPI32.dll"
#cfunc global StartServiceCtrlDispatcherA "StartServiceCtrlDispatcherA" var
; res = StartServiceCtrlDispatcherA(lpServiceStartTable)
; lpServiceStartTable : SERVICE_TABLE_ENTRYA* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL StartServiceCtrlDispatcherA(SERVICE_TABLE_ENTRYA* lpServiceStartTable)
#uselib "ADVAPI32.dll"
#cfunc global StartServiceCtrlDispatcherA "StartServiceCtrlDispatcherA" var
; res = StartServiceCtrlDispatcherA(lpServiceStartTable)
; lpServiceStartTable : SERVICE_TABLE_ENTRYA* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procStartServiceCtrlDispatcherA = advapi32.NewProc("StartServiceCtrlDispatcherA")
)

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

extern "advapi32" fn StartServiceCtrlDispatcherA(
    lpServiceStartTable: [*c]SERVICE_TABLE_ENTRYA // SERVICE_TABLE_ENTRYA*
) callconv(std.os.windows.WINAPI) i32;
proc StartServiceCtrlDispatcherA(
    lpServiceStartTable: ptr SERVICE_TABLE_ENTRYA  # SERVICE_TABLE_ENTRYA*
): int32 {.importc: "StartServiceCtrlDispatcherA", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
int StartServiceCtrlDispatcherA(
    SERVICE_TABLE_ENTRYA* lpServiceStartTable   // SERVICE_TABLE_ENTRYA*
);
ccall((:StartServiceCtrlDispatcherA, "ADVAPI32.dll"), stdcall, Int32,
      (Ptr{SERVICE_TABLE_ENTRYA},),
      lpServiceStartTable)
# lpServiceStartTable : SERVICE_TABLE_ENTRYA* -> Ptr{SERVICE_TABLE_ENTRYA}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t StartServiceCtrlDispatcherA(
    void* lpServiceStartTable);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.StartServiceCtrlDispatcherA(lpServiceStartTable)
-- lpServiceStartTable : SERVICE_TABLE_ENTRYA*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const StartServiceCtrlDispatcherA = lib.func('__stdcall', 'StartServiceCtrlDispatcherA', 'int32_t', ['void *']);
// StartServiceCtrlDispatcherA(lpServiceStartTable)
// lpServiceStartTable : SERVICE_TABLE_ENTRYA* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  StartServiceCtrlDispatcherA: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.StartServiceCtrlDispatcherA(lpServiceStartTable)
// lpServiceStartTable : SERVICE_TABLE_ENTRYA* -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t StartServiceCtrlDispatcherA(
    void* lpServiceStartTable);
C, "ADVAPI32.dll");
// $ffi->StartServiceCtrlDispatcherA(lpServiceStartTable);
// lpServiceStartTable : SERVICE_TABLE_ENTRYA*
// 構造体/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 Advapi32 extends StdCallLibrary {
    Advapi32 INSTANCE = Native.load("advapi32", Advapi32.class, W32APIOptions.ASCII_OPTIONS);
    boolean StartServiceCtrlDispatcherA(
        Pointer lpServiceStartTable   // SERVICE_TABLE_ENTRYA*
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun StartServiceCtrlDispatcherA = StartServiceCtrlDispatcherA(
    lpServiceStartTable : SERVICE_TABLE_ENTRYA*   # SERVICE_TABLE_ENTRYA*
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef StartServiceCtrlDispatcherANative = Int32 Function(Pointer<Void>);
typedef StartServiceCtrlDispatcherADart = int Function(Pointer<Void>);
final StartServiceCtrlDispatcherA = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<StartServiceCtrlDispatcherANative, StartServiceCtrlDispatcherADart>('StartServiceCtrlDispatcherA');
// lpServiceStartTable : SERVICE_TABLE_ENTRYA* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function StartServiceCtrlDispatcherA(
  lpServiceStartTable: Pointer   // SERVICE_TABLE_ENTRYA*
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'StartServiceCtrlDispatcherA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "StartServiceCtrlDispatcherA"
  c_StartServiceCtrlDispatcherA :: Ptr () -> IO CInt
-- lpServiceStartTable : SERVICE_TABLE_ENTRYA* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let startservicectrldispatchera =
  foreign "StartServiceCtrlDispatcherA"
    ((ptr void) @-> returning int32_t)
(* lpServiceStartTable : SERVICE_TABLE_ENTRYA* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("StartServiceCtrlDispatcherA" start-service-ctrl-dispatcher-a :convention :stdcall) :int32
  (lp-service-start-table :pointer))   ; SERVICE_TABLE_ENTRYA*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $StartServiceCtrlDispatcherA = Win32::API::More->new('ADVAPI32',
    'BOOL StartServiceCtrlDispatcherA(LPVOID lpServiceStartTable)');
# my $ret = $StartServiceCtrlDispatcherA->Call($lpServiceStartTable);
# lpServiceStartTable : SERVICE_TABLE_ENTRYA* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目
使用する型