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

RegisterServiceCtrlHandlerA

関数
サービスの制御要求ハンドラ関数を登録する。
DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

SERVICE_STATUS_HANDLE RegisterServiceCtrlHandlerA(
    LPCSTR lpServiceName,
    LPHANDLER_FUNCTION lpHandlerProc
);

パラメーター

名前方向説明
lpServiceNameLPCSTRin

呼び出し元スレッドが実行するサービスの名前。これは、サービスを作成する際にサービス制御プログラムが CreateService 関数で指定したサービス名です。

サービスの種類が SERVICE_WIN32_OWN_PROCESS の場合、プロセス内に登録されているサービスは 1 つだけであるため、この関数は指定された名前が有効かどうかを検証しません。

lpHandlerProcLPHANDLER_FUNCTIONin登録するハンドラー関数へのポインター。詳細については、 Handler を参照してください。

戻り値の型: SERVICE_STATUS_HANDLE

公式ドキュメント

サービス制御要求を処理する関数を登録します。(ANSI)

戻り値

関数が成功した場合、戻り値はサービス状態ハンドルです。

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

サービス制御マネージャーによって、次のエラーコードが設定される場合があります。

戻り値 説明
ERROR_NOT_ENOUGH_MEMORY
ANSI 文字列パラメーターを Unicode に変換するための十分なメモリがありません。このエラーは Unicode 文字列パラメーターでは発生しません。
ERROR_SERVICE_NOT_IN_EXE
プロセスが StartServiceCtrlDispatcher 関数を呼び出したときに、サービスエントリが正しく指定されていませんでした。

解説(Remarks)

新しいサービスの ServiceMain 関数は、ただちに RegisterServiceCtrlHandler 関数を呼び出して、制御ディスパッチャーに制御ハンドラー関数を登録する必要があります。これにより、制御ディスパッチャーは、このサービスに対する制御要求を受け取ったときに、指定された関数を呼び出せるようになります。設定可能な制御コードの一覧については、Handler を参照してください。呼び出し元プロセスのスレッドは、この関数が返すサービス状態ハンドルを使用して、後続の SetServiceStatus 関数の呼び出しでサービスを識別できます。

RegisterServiceCtrlHandler 関数は、最初の SetServiceStatus 呼び出しの前に呼び出す必要があります。これは、RegisterServiceCtrlHandler が呼び出し元の使用するサービス状態ハンドルを返すことで、他のサービスが誤ってこのサービスの状態を設定できないようにするためです。さらに、サービスが SetServiceStatus 関数を通じて受け入れる制御を指定する時点までに、制御要求を受け取れるよう制御ハンドラーが配置されている必要があります。

制御ハンドラー関数が制御要求とともに呼び出されたとき、サービスは、サービスの状態が変化した場合 (停止やシャットダウンの制御を処理しているときなど) にのみ、 SetServiceStatus を呼び出してサービス制御マネージャーに状態を報告する必要があります。サービスの状態が変化していない場合、サービスはサービス制御マネージャーに状態を報告すべきではありません。

サービス状態ハンドルを閉じる必要はありません。

例については、 Writing a ServiceMain Function を参照してください。

メモ

winsvc.h ヘッダーは、RegisterServiceCtrlHandler を、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  (ANSI / -A)
#include <windows.h>

SERVICE_STATUS_HANDLE RegisterServiceCtrlHandlerA(
    LPCSTR lpServiceName,
    LPHANDLER_FUNCTION lpHandlerProc
);
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr RegisterServiceCtrlHandlerA(
    [MarshalAs(UnmanagedType.LPStr)] string lpServiceName,   // LPCSTR
    IntPtr lpHandlerProc   // LPHANDLER_FUNCTION
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function RegisterServiceCtrlHandlerA(
    <MarshalAs(UnmanagedType.LPStr)> lpServiceName As String,   ' LPCSTR
    lpHandlerProc As IntPtr   ' LPHANDLER_FUNCTION
) As IntPtr
End Function
' lpServiceName : LPCSTR
' lpHandlerProc : LPHANDLER_FUNCTION
Declare PtrSafe Function RegisterServiceCtrlHandlerA Lib "advapi32" ( _
    ByVal lpServiceName As String, _
    ByVal lpHandlerProc As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RegisterServiceCtrlHandlerA = ctypes.windll.advapi32.RegisterServiceCtrlHandlerA
RegisterServiceCtrlHandlerA.restype = ctypes.c_void_p
RegisterServiceCtrlHandlerA.argtypes = [
    wintypes.LPCSTR,  # lpServiceName : LPCSTR
    ctypes.c_void_p,  # lpHandlerProc : LPHANDLER_FUNCTION
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
RegisterServiceCtrlHandlerA = Fiddle::Function.new(
  lib['RegisterServiceCtrlHandlerA'],
  [
    Fiddle::TYPE_VOIDP,  # lpServiceName : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpHandlerProc : LPHANDLER_FUNCTION
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "advapi32")]
extern "system" {
    fn RegisterServiceCtrlHandlerA(
        lpServiceName: *const u8,  // LPCSTR
        lpHandlerProc: *const core::ffi::c_void  // LPHANDLER_FUNCTION
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern IntPtr RegisterServiceCtrlHandlerA([MarshalAs(UnmanagedType.LPStr)] string lpServiceName, IntPtr lpHandlerProc);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegisterServiceCtrlHandlerA' -Namespace Win32 -PassThru
# $api::RegisterServiceCtrlHandlerA(lpServiceName, lpHandlerProc)
#uselib "ADVAPI32.dll"
#func global RegisterServiceCtrlHandlerA "RegisterServiceCtrlHandlerA" sptr, sptr
; RegisterServiceCtrlHandlerA lpServiceName, lpHandlerProc   ; 戻り値は stat
; lpServiceName : LPCSTR -> "sptr"
; lpHandlerProc : LPHANDLER_FUNCTION -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ADVAPI32.dll"
#cfunc global RegisterServiceCtrlHandlerA "RegisterServiceCtrlHandlerA" str, sptr
; res = RegisterServiceCtrlHandlerA(lpServiceName, lpHandlerProc)
; lpServiceName : LPCSTR -> "str"
; lpHandlerProc : LPHANDLER_FUNCTION -> "sptr"
; SERVICE_STATUS_HANDLE RegisterServiceCtrlHandlerA(LPCSTR lpServiceName, LPHANDLER_FUNCTION lpHandlerProc)
#uselib "ADVAPI32.dll"
#cfunc global RegisterServiceCtrlHandlerA "RegisterServiceCtrlHandlerA" str, intptr
; res = RegisterServiceCtrlHandlerA(lpServiceName, lpHandlerProc)
; lpServiceName : LPCSTR -> "str"
; lpHandlerProc : LPHANDLER_FUNCTION -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procRegisterServiceCtrlHandlerA = advapi32.NewProc("RegisterServiceCtrlHandlerA")
)

// lpServiceName (LPCSTR), lpHandlerProc (LPHANDLER_FUNCTION)
r1, _, err := procRegisterServiceCtrlHandlerA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpServiceName))),
	uintptr(lpHandlerProc),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // SERVICE_STATUS_HANDLE
function RegisterServiceCtrlHandlerA(
  lpServiceName: PAnsiChar;   // LPCSTR
  lpHandlerProc: Pointer   // LPHANDLER_FUNCTION
): THandle; stdcall;
  external 'ADVAPI32.dll' name 'RegisterServiceCtrlHandlerA';
result := DllCall("ADVAPI32\RegisterServiceCtrlHandlerA"
    , "AStr", lpServiceName   ; LPCSTR
    , "Ptr", lpHandlerProc   ; LPHANDLER_FUNCTION
    , "Ptr")   ; return: SERVICE_STATUS_HANDLE
●RegisterServiceCtrlHandlerA(lpServiceName, lpHandlerProc) = DLL("ADVAPI32.dll", "void* RegisterServiceCtrlHandlerA(char*, void*)")
# 呼び出し: RegisterServiceCtrlHandlerA(lpServiceName, lpHandlerProc)
# lpServiceName : LPCSTR -> "char*"
# lpHandlerProc : LPHANDLER_FUNCTION -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "advapi32" fn RegisterServiceCtrlHandlerA(
    lpServiceName: [*c]const u8, // LPCSTR
    lpHandlerProc: ?*anyopaque // LPHANDLER_FUNCTION
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc RegisterServiceCtrlHandlerA(
    lpServiceName: cstring,  # LPCSTR
    lpHandlerProc: pointer  # LPHANDLER_FUNCTION
): pointer {.importc: "RegisterServiceCtrlHandlerA", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
void* RegisterServiceCtrlHandlerA(
    const(char)* lpServiceName,   // LPCSTR
    void* lpHandlerProc   // LPHANDLER_FUNCTION
);
ccall((:RegisterServiceCtrlHandlerA, "ADVAPI32.dll"), stdcall, Ptr{Cvoid},
      (Cstring, Ptr{Cvoid}),
      lpServiceName, lpHandlerProc)
# lpServiceName : LPCSTR -> Cstring
# lpHandlerProc : LPHANDLER_FUNCTION -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* RegisterServiceCtrlHandlerA(
    const char* lpServiceName,
    void* lpHandlerProc);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.RegisterServiceCtrlHandlerA(lpServiceName, lpHandlerProc)
-- lpServiceName : LPCSTR
-- lpHandlerProc : LPHANDLER_FUNCTION
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const RegisterServiceCtrlHandlerA = lib.func('__stdcall', 'RegisterServiceCtrlHandlerA', 'void *', ['str', 'void *']);
// RegisterServiceCtrlHandlerA(lpServiceName, lpHandlerProc)
// lpServiceName : LPCSTR -> 'str'
// lpHandlerProc : LPHANDLER_FUNCTION -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("ADVAPI32.dll", {
  RegisterServiceCtrlHandlerA: { parameters: ["buffer", "pointer"], result: "pointer" },
});
// lib.symbols.RegisterServiceCtrlHandlerA(lpServiceName, lpHandlerProc)
// lpServiceName : LPCSTR -> "buffer"
// lpHandlerProc : LPHANDLER_FUNCTION -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* RegisterServiceCtrlHandlerA(
    const char* lpServiceName,
    void* lpHandlerProc);
C, "ADVAPI32.dll");
// $ffi->RegisterServiceCtrlHandlerA(lpServiceName, lpHandlerProc);
// lpServiceName : LPCSTR
// lpHandlerProc : LPHANDLER_FUNCTION
// 構造体/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);
    Pointer RegisterServiceCtrlHandlerA(
        String lpServiceName,   // LPCSTR
        Callback lpHandlerProc   // LPHANDLER_FUNCTION
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun RegisterServiceCtrlHandlerA = RegisterServiceCtrlHandlerA(
    lpServiceName : UInt8*,   # LPCSTR
    lpHandlerProc : Void*   # LPHANDLER_FUNCTION
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef RegisterServiceCtrlHandlerANative = Pointer<Void> Function(Pointer<Utf8>, Pointer<Void>);
typedef RegisterServiceCtrlHandlerADart = Pointer<Void> Function(Pointer<Utf8>, Pointer<Void>);
final RegisterServiceCtrlHandlerA = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<RegisterServiceCtrlHandlerANative, RegisterServiceCtrlHandlerADart>('RegisterServiceCtrlHandlerA');
// lpServiceName : LPCSTR -> Pointer<Utf8>
// lpHandlerProc : LPHANDLER_FUNCTION -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RegisterServiceCtrlHandlerA(
  lpServiceName: PAnsiChar;   // LPCSTR
  lpHandlerProc: Pointer   // LPHANDLER_FUNCTION
): THandle; stdcall;
  external 'ADVAPI32.dll' name 'RegisterServiceCtrlHandlerA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RegisterServiceCtrlHandlerA"
  c_RegisterServiceCtrlHandlerA :: CString -> Ptr () -> IO (Ptr ())
-- lpServiceName : LPCSTR -> CString
-- lpHandlerProc : LPHANDLER_FUNCTION -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let registerservicectrlhandlera =
  foreign "RegisterServiceCtrlHandlerA"
    (string @-> (ptr void) @-> returning (ptr void))
(* lpServiceName : LPCSTR -> string *)
(* lpHandlerProc : LPHANDLER_FUNCTION -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("RegisterServiceCtrlHandlerA" register-service-ctrl-handler-a :convention :stdcall) :pointer
  (lp-service-name :string)   ; LPCSTR
  (lp-handler-proc :pointer))   ; LPHANDLER_FUNCTION
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RegisterServiceCtrlHandlerA = Win32::API::More->new('ADVAPI32',
    'HANDLE RegisterServiceCtrlHandlerA(LPCSTR lpServiceName, LPVOID lpHandlerProc)');
# my $ret = $RegisterServiceCtrlHandlerA->Call($lpServiceName, $lpHandlerProc);
# lpServiceName : LPCSTR -> LPCSTR
# lpHandlerProc : LPHANDLER_FUNCTION -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

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