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

ControlService

関数
実行中のサービスへ制御コードを送信する。
DLLADVAPI32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL ControlService(
    SC_HANDLE hService,
    DWORD dwControl,
    SERVICE_STATUS* lpServiceStatus
);

パラメーター

名前方向説明
hServiceSC_HANDLEinサービスへのハンドル。このハンドルは OpenService 関数または CreateService 関数によって返されます。このハンドルに必要な アクセス権 は、要求する dwControl コードによって異なります。
dwControlDWORDin

このパラメーターには、次のいずれかの制御コードを指定できます。

制御コード 意味
SERVICE_CONTROL_CONTINUE
0x00000003
一時停止中のサービスに、再開すべきであることを通知します。hService ハンドルには SERVICE_PAUSE_CONTINUE アクセス権が必要です。
SERVICE_CONTROL_INTERROGATE
0x00000004
サービスに、現在の状態情報をサービス制御マネージャーに報告すべきであることを通知します。 hService ハンドルには SERVICE_INTERROGATE アクセス権が必要です。

SCM はサービスの現在の状態を把握しているため、この制御は一般的には有用ではない点に注意してください。

SERVICE_CONTROL_NETBINDADD
0x00000007
ネットワークサービスに、バインド対象の新しいコンポーネントがあることを通知します。 hService ハンドルには SERVICE_PAUSE_CONTINUE アクセス権が必要です。ただし、この制御コードは非推奨です。代わりにプラグアンドプレイ機能を使用してください。
SERVICE_CONTROL_NETBINDDISABLE
0x0000000A
ネットワークサービスに、そのバインドの 1 つが無効化されたことを通知します。 hService ハンドルには SERVICE_PAUSE_CONTINUE アクセス権が必要です。ただし、この制御コードは非推奨です。代わりにプラグアンドプレイ機能を使用してください。
SERVICE_CONTROL_NETBINDENABLE
0x00000009
ネットワークサービスに、無効化されていたバインドが有効化されたことを通知します。 hService ハンドルには SERVICE_PAUSE_CONTINUE アクセス権が必要です。ただし、この制御コードは非推奨です。代わりにプラグアンドプレイ機能を使用してください。
SERVICE_CONTROL_NETBINDREMOVE
0x00000008
ネットワークサービスに、バインド対象のコンポーネントが削除されたことを通知します。 hService ハンドルには SERVICE_PAUSE_CONTINUE アクセス権が必要です。ただし、この制御コードは非推奨です。代わりにプラグアンドプレイ機能を使用してください。
SERVICE_CONTROL_PARAMCHANGE
0x00000006
サービスに、その起動パラメーターが変更されたことを通知します。hService ハンドルには SERVICE_PAUSE_CONTINUE アクセス権が必要です。
SERVICE_CONTROL_PAUSE
0x00000002
サービスに、一時停止すべきであることを通知します。hService ハンドルには SERVICE_PAUSE_CONTINUE アクセス権が必要です。
SERVICE_CONTROL_STOP
0x00000001
サービスに、停止すべきであることを通知します。hService ハンドルには SERVICE_STOP アクセス権が必要です。

サービスに停止要求を送信した後は、そのサービスに他の制御を送信しないでください。

この値には、次の表で説明するユーザー定義の制御コードを指定することもできます。

制御コード 意味
128 から 255 の範囲
サービスが、制御コードに関連付けられた動作を定義します。hService ハンドルには SERVICE_USER_DEFINED_CONTROL アクセス権が必要です。
lpServiceStatusSERVICE_STATUS*out

最新のサービス状態情報を受け取る SERVICE_STATUS 構造体へのポインター。 返される情報は、サービスがサービス制御マネージャーに報告した最新の状態を反映します。

サービス制御マネージャーは、 GetLastError が次のいずれかのエラーコードを返す場合にのみ、この構造体に値を設定します。 NO_ERRORERROR_INVALID_SERVICE_CONTROLERROR_SERVICE_CANNOT_ACCEPT_CTRL、または ERROR_SERVICE_NOT_ACTIVE。それ以外の場合、構造体には値が設定されません。

戻り値の型: BOOL

公式ドキュメント

サービスに制御コードを送信します。(ControlService)

戻り値

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

関数が失敗した場合、戻り値は 0 です。詳細なエラー情報を取得するには、 GetLastError を呼び出してください。

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

戻り値コード 説明
ERROR_ACCESS_DENIED
ハンドルに必要なアクセス権がありません。
ERROR_DEPENDENT_SERVICES_RUNNING
実行中の他のサービスがこのサービスに依存しているため、サービスを停止できません。
ERROR_INVALID_HANDLE
指定されたハンドルが CreateService または OpenService を使用して取得されたものではないか、ハンドルが既に 無効です。
ERROR_INVALID_PARAMETER
要求された制御コードが未定義です。
ERROR_INVALID_SERVICE_CONTROL
要求された制御コードが無効であるか、サービスが受け付けられません。
ERROR_SERVICE_CANNOT_ACCEPT_CTRL
サービスの状態が SERVICE_STOPPEDSERVICE_START_PENDING、または SERVICE_STOP_PENDING であるため、要求された制御コードをサービスに送信できません。
ERROR_SERVICE_NOT_ACTIVE
サービスが開始されていません。
ERROR_SERVICE_REQUEST_TIMEOUT
サービスのプロセスは開始されましたが、 StartServiceCtrlDispatcher を呼び出さなかったか、 StartServiceCtrlDispatcher を呼び出したスレッドが制御ハンドラー関数内でブロックされている可能性があります。
ERROR_SHUTDOWN_IN_PROGRESS
システムがシャットダウン中です。

解説(Remarks)

ControlService 関数は、要求された制御コードをサービスに送信するようサービス制御マネージャー (SCM) に依頼します。 SCM は、サービスがそのコードを受け付けることを指定しており、かつ制御コードを送信できる状態にある場合にコードを送信します。

SCM はサービス制御通知を直列的に処理します。つまり、あるサービスがサービス制御通知の処理を完了するのを待ってから、 次の通知を送信します。このため、いずれかのサービスが制御コードの処理でビジー状態にある場合、 ControlService の呼び出しは 30 秒間ブロックされます。タイムアウトが経過してもビジー状態のサービスがハンドラー関数から戻らない場合、 ControlServiceERROR_SERVICE_REQUEST_TIMEOUT で失敗します。

サービスを停止および開始するには、それを許可するセキュリティ記述子が必要です。既定のセキュリティ記述子では、 LocalSystem アカウント、および Administrators グループと Power Users グループのメンバーがサービスの停止と開始を行えます。サービスのセキュリティ記述子を変更するには、 サービスの DACL を変更する を参照してください。

QueryServiceStatusEx 関数は SERVICE_STATUS_PROCESS 構造体を返します。この構造体の dwCurrentState メンバーと dwControlsAccepted メンバーは、 実行中のサービスの現在の状態と受け付け可能な制御を示します。実行中のすべてのサービスは、既定で SERVICE_CONTROL_INTERROGATE 制御コードを受け付けます。ドライバーは SERVICE_CONTROL_STOPSERVICE_CONTROL_INTERROGATE 以外の制御コードを受け付けません。各サービスは、状態を報告するために SetServiceStatus 関数を呼び出すときに、受け付けるその他の制御コードを指定します。 サービスは、実行中は何をしているかにかかわらず、常にこれらのコードを受け付けるべきです。

次の表は、可能な各サービス状態における SCM の動作を示します。

サービス状態 Stop その他の制御
STOPPED (c) (c)
STOP_PENDING (b) (b)
START_PENDING (a) (b)
RUNNING (a) (a)
CONTINUE_PENDING (a) (a)
PAUSE_PENDING (a) (a)
PAUSED (a) (a)
(a)
サービスがこの制御コードを受け付ける場合、要求をサービスに送信します。受け付けない場合、ControlService は 0 を返し、 GetLastErrorERROR_INVALID_SERVICE_CONTROL を返します。
(b)
サービスが制御を送信できる状態にないため、ControlService は 0 を返し、 GetLastErrorERROR_SERVICE_CANNOT_ACCEPT_CTRL を返します。
(c)
サービスがアクティブでないため、ControlService は 0 を返し、 GetLastErrorERROR_SERVICE_NOT_ACTIVE を返します。

例については、サービスの停止 を参照してください。

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

各言語での呼び出し定義

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

BOOL ControlService(
    SC_HANDLE hService,
    DWORD dwControl,
    SERVICE_STATUS* lpServiceStatus
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ControlService(
    IntPtr hService,   // SC_HANDLE
    uint dwControl,   // DWORD
    IntPtr lpServiceStatus   // SERVICE_STATUS* out
);
<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ControlService(
    hService As IntPtr,   ' SC_HANDLE
    dwControl As UInteger,   ' DWORD
    lpServiceStatus As IntPtr   ' SERVICE_STATUS* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hService : SC_HANDLE
' dwControl : DWORD
' lpServiceStatus : SERVICE_STATUS* out
Declare PtrSafe Function ControlService Lib "advapi32" ( _
    ByVal hService As LongPtr, _
    ByVal dwControl As Long, _
    ByVal lpServiceStatus As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ControlService = ctypes.windll.advapi32.ControlService
ControlService.restype = wintypes.BOOL
ControlService.argtypes = [
    wintypes.HANDLE,  # hService : SC_HANDLE
    wintypes.DWORD,  # dwControl : DWORD
    ctypes.c_void_p,  # lpServiceStatus : SERVICE_STATUS* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procControlService = advapi32.NewProc("ControlService")
)

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

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

typedef ControlServiceNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Void>);
typedef ControlServiceDart = int Function(Pointer<Void>, int, Pointer<Void>);
final ControlService = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<ControlServiceNative, ControlServiceDart>('ControlService');
// hService : SC_HANDLE -> Pointer<Void>
// dwControl : DWORD -> Uint32
// lpServiceStatus : SERVICE_STATUS* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ControlService(
  hService: THandle;   // SC_HANDLE
  dwControl: DWORD;   // DWORD
  lpServiceStatus: Pointer   // SERVICE_STATUS* out
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'ControlService';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ControlService"
  c_ControlService :: Ptr () -> Word32 -> Ptr () -> IO CInt
-- hService : SC_HANDLE -> Ptr ()
-- dwControl : DWORD -> Word32
-- lpServiceStatus : SERVICE_STATUS* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let controlservice =
  foreign "ControlService"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* hService : SC_HANDLE -> (ptr void) *)
(* dwControl : DWORD -> uint32_t *)
(* lpServiceStatus : SERVICE_STATUS* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("ControlService" control-service :convention :stdcall) :int32
  (h-service :pointer)   ; SC_HANDLE
  (dw-control :uint32)   ; DWORD
  (lp-service-status :pointer))   ; SERVICE_STATUS* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ControlService = Win32::API::More->new('ADVAPI32',
    'BOOL ControlService(HANDLE hService, DWORD dwControl, LPVOID lpServiceStatus)');
# my $ret = $ControlService->Call($hService, $dwControl, $lpServiceStatus);
# hService : SC_HANDLE -> HANDLE
# dwControl : DWORD -> DWORD
# lpServiceStatus : SERVICE_STATUS* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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