ControlServiceExA
関数シグネチャ
// ADVAPI32.dll (ANSI / -A)
#include <windows.h>
BOOL ControlServiceExA(
SC_HANDLE hService,
DWORD dwControl,
DWORD dwInfoLevel,
void* pControlParams
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| hService | SC_HANDLE | in | サービスへのハンドル。このハンドルは OpenService 関数または CreateService 関数によって返されます。このハンドルに必要な アクセス権 は、要求する dwControl コードによって異なります。 | ||||||||||||||||||||||||
| dwControl | DWORD | in | このパラメーターには、次のいずれかの制御コードを指定できます。
このパラメーターには、次の表に示すユーザー定義の制御コードを指定することもできます。
| ||||||||||||||||||||||||
| dwInfoLevel | DWORD | in | サービス制御パラメーターの情報レベル。このパラメーターには SERVICE_CONTROL_STATUS_REASON_INFO (1) を設定する必要があります。 | ||||||||||||||||||||||||
| pControlParams | void* | inout | サービス制御パラメーターへのポインター。dwInfoLevel が SERVICE_CONTROL_STATUS_REASON_INFO の場合、このメンバーは SERVICE_CONTROL_STATUS_REASON_PARAMS 構造体へのポインターです。 |
戻り値の型: BOOL
公式ドキュメント
サービスに制御コードを送信します。(ControlServiceExA)
戻り値
関数が成功すると、戻り値は 0 以外の値になります。
関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。
次のエラーコードはサービス制御マネージャーによって設定されることがあります。他のエラーコードは、サービス制御マネージャーから呼び出されるレジストリ関数によって設定されることがあります。
| 戻り値コード | 説明 |
|---|---|
| ハンドルに必要なアクセス権がありません。 | |
| 実行中の他のサービスがこのサービスに依存しているため、サービスを停止できません。 | |
| 指定されたハンドルが CreateService または OpenService を使用して取得されたものではないか、ハンドルが既に無効になっています。 | |
| dwControl パラメーターで要求された制御コードが未定義であるか、dwControl が SERVICE_CONTROL_STOP であるものの SERVICE_CONTROL_STATUS_REASON_PARAMS 構造体の dwReason または pszComment メンバーが有効でありません。 | |
| 要求された制御コードが有効でないか、サービスがそれを受け付けません。 | |
| サービスの状態が SERVICE_STOPPED、SERVICE_START_PENDING、または SERVICE_STOP_PENDING であるため、要求された制御コードをサービスに送信できません。 | |
| サービスが開始されていません。 | |
| サービスのプロセスは開始されたものの、 StartServiceCtrlDispatcher を呼び出していないか、 StartServiceCtrlDispatcher を呼び出したスレッドが制御ハンドラー関数内でブロックされている可能性があります。 | |
| システムがシャットダウン中です。 |
解説(Remarks)
ControlServiceEx 関数は、要求された制御コードをサービスに送信するようサービス制御マネージャー (SCM) に依頼します。サービスがそのコードを受け付けると指定しており、かつ制御コードを送信できる状態にある場合、SCM はそのコードを送信します。
SCM はサービス制御通知を直列的に処理します。つまり、あるサービスが 1 つのサービス制御通知の処理を完了するまで待ってから、次の通知を送信します。このため、いずれかのサービスが制御コードの処理でビジー状態の場合、ControlServiceEx の呼び出しは 30 秒間ブロックされます。タイムアウトが経過してもビジー状態のサービスがハンドラー関数から戻っていない場合、ControlServiceEx は ERROR_SERVICE_REQUEST_TIMEOUT で失敗します。
サービスの停止と開始には、それを許可するセキュリティ記述子が必要です。既定のセキュリティ記述子では、 LocalSystem アカウント および Administrators グループと Power Users グループのメンバーがサービスの停止と開始を行えます。サービスのセキュリティ記述子を変更するには、 Modifying the DACL for a Service を参照してください。
QueryServiceStatusEx 関数は SERVICE_STATUS_PROCESS 構造体を返します。この構造体の dwCurrentState メンバーと dwControlsAccepted メンバーは、実行中のサービスの現在の状態と受け付ける制御を示します。実行中のすべてのサービスは、既定で SERVICE_CONTROL_INTERROGATE 制御コードを受け付けます。ドライバーは SERVICE_CONTROL_STOP と SERVICE_CONTROL_INTERROGATE 以外の制御コードを受け付けません。各サービスは、状態を報告するために SetServiceStatus 関数を呼び出す際に、受け付けるその他の制御コードを指定します。サービスは、実行中であれば何を行っていても、常にこれらのコードを受け付けるべきです。
次の表は、可能な各サービス状態における SCM の動作を示しています。
| サービス状態 | 停止 | その他の制御 |
|---|---|---|
| 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)
- サービスがこの制御コードを受け付ける場合、要求をサービスに送信します。受け付けない場合、ControlServiceEx は 0 を返し、GetLastError は ERROR_INVALID_SERVICE_CONTROL を返します。
- (b)
- サービスが制御を送信できる状態にないため、ControlServiceEx は 0 を返し、 GetLastError は ERROR_SERVICE_CANNOT_ACCEPT_CTRL を返します。
- (c)
- サービスがアクティブでないため、ControlServiceEx は 0 を返し、 GetLastError は ERROR_SERVICE_NOT_ACTIVE を返します。
winsvc.h ヘッダーは ControlServiceEx をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング非依存のエイリアスの使用と、エンコーディング非依存でないコードを混在させると、コンパイルエラーや実行時エラーを引き起こす不整合が生じる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// ADVAPI32.dll (ANSI / -A)
#include <windows.h>
BOOL ControlServiceExA(
SC_HANDLE hService,
DWORD dwControl,
DWORD dwInfoLevel,
void* pControlParams
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool ControlServiceExA(
IntPtr hService, // SC_HANDLE
uint dwControl, // DWORD
uint dwInfoLevel, // DWORD
IntPtr pControlParams // void* in/out
);<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ControlServiceExA(
hService As IntPtr, ' SC_HANDLE
dwControl As UInteger, ' DWORD
dwInfoLevel As UInteger, ' DWORD
pControlParams As IntPtr ' void* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' hService : SC_HANDLE
' dwControl : DWORD
' dwInfoLevel : DWORD
' pControlParams : void* in/out
Declare PtrSafe Function ControlServiceExA Lib "advapi32" ( _
ByVal hService As LongPtr, _
ByVal dwControl As Long, _
ByVal dwInfoLevel As Long, _
ByVal pControlParams As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
ControlServiceExA = ctypes.windll.advapi32.ControlServiceExA
ControlServiceExA.restype = wintypes.BOOL
ControlServiceExA.argtypes = [
wintypes.HANDLE, # hService : SC_HANDLE
wintypes.DWORD, # dwControl : DWORD
wintypes.DWORD, # dwInfoLevel : DWORD
ctypes.POINTER(None), # pControlParams : void* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('ADVAPI32.dll')
ControlServiceExA = Fiddle::Function.new(
lib['ControlServiceExA'],
[
Fiddle::TYPE_VOIDP, # hService : SC_HANDLE
-Fiddle::TYPE_INT, # dwControl : DWORD
-Fiddle::TYPE_INT, # dwInfoLevel : DWORD
Fiddle::TYPE_VOIDP, # pControlParams : void* in/out
],
Fiddle::TYPE_INT)#[link(name = "advapi32")]
extern "system" {
fn ControlServiceExA(
hService: *mut core::ffi::c_void, // SC_HANDLE
dwControl: u32, // DWORD
dwInfoLevel: u32, // DWORD
pControlParams: *mut () // void* in/out
) -> 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 ControlServiceExA(IntPtr hService, uint dwControl, uint dwInfoLevel, IntPtr pControlParams);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_ControlServiceExA' -Namespace Win32 -PassThru
# $api::ControlServiceExA(hService, dwControl, dwInfoLevel, pControlParams)#uselib "ADVAPI32.dll"
#func global ControlServiceExA "ControlServiceExA" sptr, sptr, sptr, sptr
; ControlServiceExA hService, dwControl, dwInfoLevel, pControlParams ; 戻り値は stat
; hService : SC_HANDLE -> "sptr"
; dwControl : DWORD -> "sptr"
; dwInfoLevel : DWORD -> "sptr"
; pControlParams : void* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "ADVAPI32.dll"
#cfunc global ControlServiceExA "ControlServiceExA" sptr, int, int, sptr
; res = ControlServiceExA(hService, dwControl, dwInfoLevel, pControlParams)
; hService : SC_HANDLE -> "sptr"
; dwControl : DWORD -> "int"
; dwInfoLevel : DWORD -> "int"
; pControlParams : void* in/out -> "sptr"; BOOL ControlServiceExA(SC_HANDLE hService, DWORD dwControl, DWORD dwInfoLevel, void* pControlParams)
#uselib "ADVAPI32.dll"
#cfunc global ControlServiceExA "ControlServiceExA" intptr, int, int, intptr
; res = ControlServiceExA(hService, dwControl, dwInfoLevel, pControlParams)
; hService : SC_HANDLE -> "intptr"
; dwControl : DWORD -> "int"
; dwInfoLevel : DWORD -> "int"
; pControlParams : void* in/out -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
procControlServiceExA = advapi32.NewProc("ControlServiceExA")
)
// hService (SC_HANDLE), dwControl (DWORD), dwInfoLevel (DWORD), pControlParams (void* in/out)
r1, _, err := procControlServiceExA.Call(
uintptr(hService),
uintptr(dwControl),
uintptr(dwInfoLevel),
uintptr(pControlParams),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction ControlServiceExA(
hService: THandle; // SC_HANDLE
dwControl: DWORD; // DWORD
dwInfoLevel: DWORD; // DWORD
pControlParams: Pointer // void* in/out
): BOOL; stdcall;
external 'ADVAPI32.dll' name 'ControlServiceExA';result := DllCall("ADVAPI32\ControlServiceExA"
, "Ptr", hService ; SC_HANDLE
, "UInt", dwControl ; DWORD
, "UInt", dwInfoLevel ; DWORD
, "Ptr", pControlParams ; void* in/out
, "Int") ; return: BOOL●ControlServiceExA(hService, dwControl, dwInfoLevel, pControlParams) = DLL("ADVAPI32.dll", "bool ControlServiceExA(void*, dword, dword, void*)")
# 呼び出し: ControlServiceExA(hService, dwControl, dwInfoLevel, pControlParams)
# hService : SC_HANDLE -> "void*"
# dwControl : DWORD -> "dword"
# dwInfoLevel : DWORD -> "dword"
# pControlParams : void* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "advapi32" fn ControlServiceExA(
hService: ?*anyopaque, // SC_HANDLE
dwControl: u32, // DWORD
dwInfoLevel: u32, // DWORD
pControlParams: ?*anyopaque // void* in/out
) callconv(std.os.windows.WINAPI) i32;proc ControlServiceExA(
hService: pointer, # SC_HANDLE
dwControl: uint32, # DWORD
dwInfoLevel: uint32, # DWORD
pControlParams: pointer # void* in/out
): int32 {.importc: "ControlServiceExA", stdcall, dynlib: "ADVAPI32.dll".}pragma(lib, "advapi32");
extern(Windows)
int ControlServiceExA(
void* hService, // SC_HANDLE
uint dwControl, // DWORD
uint dwInfoLevel, // DWORD
void* pControlParams // void* in/out
);ccall((:ControlServiceExA, "ADVAPI32.dll"), stdcall, Int32,
(Ptr{Cvoid}, UInt32, UInt32, Ptr{Cvoid}),
hService, dwControl, dwInfoLevel, pControlParams)
# hService : SC_HANDLE -> Ptr{Cvoid}
# dwControl : DWORD -> UInt32
# dwInfoLevel : DWORD -> UInt32
# pControlParams : void* in/out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t ControlServiceExA(
void* hService,
uint32_t dwControl,
uint32_t dwInfoLevel,
void* pControlParams);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.ControlServiceExA(hService, dwControl, dwInfoLevel, pControlParams)
-- hService : SC_HANDLE
-- dwControl : DWORD
-- dwInfoLevel : DWORD
-- pControlParams : void* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const ControlServiceExA = lib.func('__stdcall', 'ControlServiceExA', 'int32_t', ['void *', 'uint32_t', 'uint32_t', 'void *']);
// ControlServiceExA(hService, dwControl, dwInfoLevel, pControlParams)
// hService : SC_HANDLE -> 'void *'
// dwControl : DWORD -> 'uint32_t'
// dwInfoLevel : DWORD -> 'uint32_t'
// pControlParams : void* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("ADVAPI32.dll", {
ControlServiceExA: { parameters: ["pointer", "u32", "u32", "pointer"], result: "i32" },
});
// lib.symbols.ControlServiceExA(hService, dwControl, dwInfoLevel, pControlParams)
// hService : SC_HANDLE -> "pointer"
// dwControl : DWORD -> "u32"
// dwInfoLevel : DWORD -> "u32"
// pControlParams : void* in/out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t ControlServiceExA(
void* hService,
uint32_t dwControl,
uint32_t dwInfoLevel,
void* pControlParams);
C, "ADVAPI32.dll");
// $ffi->ControlServiceExA(hService, dwControl, dwInfoLevel, pControlParams);
// hService : SC_HANDLE
// dwControl : DWORD
// dwInfoLevel : DWORD
// pControlParams : void* in/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, W32APIOptions.ASCII_OPTIONS);
boolean ControlServiceExA(
Pointer hService, // SC_HANDLE
int dwControl, // DWORD
int dwInfoLevel, // DWORD
Pointer pControlParams // void* in/out
);
}@[Link("advapi32")]
lib LibADVAPI32
fun ControlServiceExA = ControlServiceExA(
hService : Void*, # SC_HANDLE
dwControl : UInt32, # DWORD
dwInfoLevel : UInt32, # DWORD
pControlParams : Void* # void* in/out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef ControlServiceExANative = Int32 Function(Pointer<Void>, Uint32, Uint32, Pointer<Void>);
typedef ControlServiceExADart = int Function(Pointer<Void>, int, int, Pointer<Void>);
final ControlServiceExA = DynamicLibrary.open('ADVAPI32.dll')
.lookupFunction<ControlServiceExANative, ControlServiceExADart>('ControlServiceExA');
// hService : SC_HANDLE -> Pointer<Void>
// dwControl : DWORD -> Uint32
// dwInfoLevel : DWORD -> Uint32
// pControlParams : void* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function ControlServiceExA(
hService: THandle; // SC_HANDLE
dwControl: DWORD; // DWORD
dwInfoLevel: DWORD; // DWORD
pControlParams: Pointer // void* in/out
): BOOL; stdcall;
external 'ADVAPI32.dll' name 'ControlServiceExA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "ControlServiceExA"
c_ControlServiceExA :: Ptr () -> Word32 -> Word32 -> Ptr () -> IO CInt
-- hService : SC_HANDLE -> Ptr ()
-- dwControl : DWORD -> Word32
-- dwInfoLevel : DWORD -> Word32
-- pControlParams : void* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let controlserviceexa =
foreign "ControlServiceExA"
((ptr void) @-> uint32_t @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* hService : SC_HANDLE -> (ptr void) *)
(* dwControl : DWORD -> uint32_t *)
(* dwInfoLevel : DWORD -> uint32_t *)
(* pControlParams : void* in/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 ("ControlServiceExA" control-service-ex-a :convention :stdcall) :int32
(h-service :pointer) ; SC_HANDLE
(dw-control :uint32) ; DWORD
(dw-info-level :uint32) ; DWORD
(p-control-params :pointer)) ; void* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $ControlServiceExA = Win32::API::More->new('ADVAPI32',
'BOOL ControlServiceExA(HANDLE hService, DWORD dwControl, DWORD dwInfoLevel, LPVOID pControlParams)');
# my $ret = $ControlServiceExA->Call($hService, $dwControl, $dwInfoLevel, $pControlParams);
# hService : SC_HANDLE -> HANDLE
# dwControl : DWORD -> DWORD
# dwInfoLevel : DWORD -> DWORD
# pControlParams : void* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f ControlServiceExW (Unicode版) — 追加パラメータを指定してサービスに制御コードを送信する。
- f ControlService — 実行中のサービスへ制御コードを送信する。
- f CreateServiceA — 新しいサービスを作成しSCMデータベースに登録する。
- f OpenServiceA — 既存サービスを開いてハンドルを取得する。
- f QueryServiceStatusEx — 指定サービスの拡張された状態情報を取得する。
- s SERVICE_CONTROL_STATUS_REASON_PARAMSA
- s SERVICE_STATUS
- f SetServiceObjectSecurity — サービスのセキュリティ記述子を設定する。
- f SetServiceStatus — サービスの状態をSCMに報告する。