ホーム › System.Services › RegisterServiceCtrlHandlerExA

RegisterServiceCtrlHandlerExA

関数

コンテキスト付きでサービス制御ハンドラ関数を登録する。

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

シグネチャ

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

SERVICE_STATUS_HANDLE RegisterServiceCtrlHandlerExA(
    LPCSTR lpServiceName,
    LPHANDLER_FUNCTION_EX lpHandlerProc,
    void* lpContext   // optional
);

パラメーター

名前	型	方向	説明
lpServiceName	LPCSTR	in	呼び出し元スレッドが実行するサービスの名前です。これは、サービス制御プログラムがサービスを作成する際に CreateService 関数で指定したサービス名です。
lpHandlerProc	LPHANDLER_FUNCTION_EX	in	登録するハンドラー関数へのポインターです。詳細については HandlerEx を参照してください。
lpContext	void*	inoptional	任意のユーザー定義データです。このパラメーターはハンドラー関数に渡され、複数のサービスが 1 つのプロセスを共有する場合にサービスを識別するのに役立ちます。

戻り値の型: SERVICE_STATUS_HANDLE

公式ドキュメント

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

戻り値

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

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

サービス制御マネージャーは、次のエラーコードを設定する場合があります。

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

解説(Remarks)

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

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

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

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 RegisterServiceCtrlHandlerExA(
    LPCSTR lpServiceName,
    LPHANDLER_FUNCTION_EX lpHandlerProc,
    void* lpContext   // optional
);

[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr RegisterServiceCtrlHandlerExA(
    [MarshalAs(UnmanagedType.LPStr)] string lpServiceName,   // LPCSTR
    IntPtr lpHandlerProc,   // LPHANDLER_FUNCTION_EX
    IntPtr lpContext   // void* optional
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function RegisterServiceCtrlHandlerExA(
    <MarshalAs(UnmanagedType.LPStr)> lpServiceName As String,   ' LPCSTR
    lpHandlerProc As IntPtr,   ' LPHANDLER_FUNCTION_EX
    lpContext As IntPtr   ' void* optional
) As IntPtr
End Function

' lpServiceName : LPCSTR
' lpHandlerProc : LPHANDLER_FUNCTION_EX
' lpContext : void* optional
Declare PtrSafe Function RegisterServiceCtrlHandlerExA Lib "advapi32" ( _
    ByVal lpServiceName As String, _
    ByVal lpHandlerProc As LongPtr, _
    ByVal lpContext As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RegisterServiceCtrlHandlerExA = ctypes.windll.advapi32.RegisterServiceCtrlHandlerExA
RegisterServiceCtrlHandlerExA.restype = ctypes.c_void_p
RegisterServiceCtrlHandlerExA.argtypes = [
    wintypes.LPCSTR,  # lpServiceName : LPCSTR
    ctypes.c_void_p,  # lpHandlerProc : LPHANDLER_FUNCTION_EX
    ctypes.POINTER(None),  # lpContext : void* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
RegisterServiceCtrlHandlerExA = Fiddle::Function.new(
  lib['RegisterServiceCtrlHandlerExA'],
  [
    Fiddle::TYPE_VOIDP,  # lpServiceName : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpHandlerProc : LPHANDLER_FUNCTION_EX
    Fiddle::TYPE_VOIDP,  # lpContext : void* optional
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "advapi32")]
extern "system" {
    fn RegisterServiceCtrlHandlerExA(
        lpServiceName: *const u8,  // LPCSTR
        lpHandlerProc: *const core::ffi::c_void,  // LPHANDLER_FUNCTION_EX
        lpContext: *mut ()  // void* optional
    ) -> *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 RegisterServiceCtrlHandlerExA([MarshalAs(UnmanagedType.LPStr)] string lpServiceName, IntPtr lpHandlerProc, IntPtr lpContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegisterServiceCtrlHandlerExA' -Namespace Win32 -PassThru
# $api::RegisterServiceCtrlHandlerExA(lpServiceName, lpHandlerProc, lpContext)

#uselib "ADVAPI32.dll"
#func global RegisterServiceCtrlHandlerExA "RegisterServiceCtrlHandlerExA" sptr, sptr, sptr
; RegisterServiceCtrlHandlerExA lpServiceName, lpHandlerProc, lpContext   ; 戻り値は stat
; lpServiceName : LPCSTR -> "sptr"
; lpHandlerProc : LPHANDLER_FUNCTION_EX -> "sptr"
; lpContext : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "ADVAPI32.dll"
#cfunc global RegisterServiceCtrlHandlerExA "RegisterServiceCtrlHandlerExA" str, sptr, sptr
; res = RegisterServiceCtrlHandlerExA(lpServiceName, lpHandlerProc, lpContext)
; lpServiceName : LPCSTR -> "str"
; lpHandlerProc : LPHANDLER_FUNCTION_EX -> "sptr"
; lpContext : void* optional -> "sptr"

; SERVICE_STATUS_HANDLE RegisterServiceCtrlHandlerExA(LPCSTR lpServiceName, LPHANDLER_FUNCTION_EX lpHandlerProc, void* lpContext)
#uselib "ADVAPI32.dll"
#cfunc global RegisterServiceCtrlHandlerExA "RegisterServiceCtrlHandlerExA" str, intptr, intptr
; res = RegisterServiceCtrlHandlerExA(lpServiceName, lpHandlerProc, lpContext)
; lpServiceName : LPCSTR -> "str"
; lpHandlerProc : LPHANDLER_FUNCTION_EX -> "intptr"
; lpContext : void* optional -> "intptr"

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procRegisterServiceCtrlHandlerExA = advapi32.NewProc("RegisterServiceCtrlHandlerExA")
)

// lpServiceName (LPCSTR), lpHandlerProc (LPHANDLER_FUNCTION_EX), lpContext (void* optional)
r1, _, err := procRegisterServiceCtrlHandlerExA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpServiceName))),
	uintptr(lpHandlerProc),
	uintptr(lpContext),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // SERVICE_STATUS_HANDLE

function RegisterServiceCtrlHandlerExA(
  lpServiceName: PAnsiChar;   // LPCSTR
  lpHandlerProc: Pointer;   // LPHANDLER_FUNCTION_EX
  lpContext: Pointer   // void* optional
): THandle; stdcall;
  external 'ADVAPI32.dll' name 'RegisterServiceCtrlHandlerExA';

result := DllCall("ADVAPI32\RegisterServiceCtrlHandlerExA"
    , "AStr", lpServiceName   ; LPCSTR
    , "Ptr", lpHandlerProc   ; LPHANDLER_FUNCTION_EX
    , "Ptr", lpContext   ; void* optional
    , "Ptr")   ; return: SERVICE_STATUS_HANDLE

●RegisterServiceCtrlHandlerExA(lpServiceName, lpHandlerProc, lpContext) = DLL("ADVAPI32.dll", "void* RegisterServiceCtrlHandlerExA(char*, void*, void*)")
# 呼び出し: RegisterServiceCtrlHandlerExA(lpServiceName, lpHandlerProc, lpContext)
# lpServiceName : LPCSTR -> "char*"
# lpHandlerProc : LPHANDLER_FUNCTION_EX -> "void*"
# lpContext : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "advapi32" fn RegisterServiceCtrlHandlerExA(
    lpServiceName: [*c]const u8, // LPCSTR
    lpHandlerProc: ?*anyopaque, // LPHANDLER_FUNCTION_EX
    lpContext: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) ?*anyopaque;

proc RegisterServiceCtrlHandlerExA(
    lpServiceName: cstring,  # LPCSTR
    lpHandlerProc: pointer,  # LPHANDLER_FUNCTION_EX
    lpContext: pointer  # void* optional
): pointer {.importc: "RegisterServiceCtrlHandlerExA", stdcall, dynlib: "ADVAPI32.dll".}

pragma(lib, "advapi32");
extern(Windows)
void* RegisterServiceCtrlHandlerExA(
    const(char)* lpServiceName,   // LPCSTR
    void* lpHandlerProc,   // LPHANDLER_FUNCTION_EX
    void* lpContext   // void* optional
);

ccall((:RegisterServiceCtrlHandlerExA, "ADVAPI32.dll"), stdcall, Ptr{Cvoid},
      (Cstring, Ptr{Cvoid}, Ptr{Cvoid}),
      lpServiceName, lpHandlerProc, lpContext)
# lpServiceName : LPCSTR -> Cstring
# lpHandlerProc : LPHANDLER_FUNCTION_EX -> Ptr{Cvoid}
# lpContext : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
void* RegisterServiceCtrlHandlerExA(
    const char* lpServiceName,
    void* lpHandlerProc,
    void* lpContext);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.RegisterServiceCtrlHandlerExA(lpServiceName, lpHandlerProc, lpContext)
-- lpServiceName : LPCSTR
-- lpHandlerProc : LPHANDLER_FUNCTION_EX
-- lpContext : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const RegisterServiceCtrlHandlerExA = lib.func('__stdcall', 'RegisterServiceCtrlHandlerExA', 'void *', ['str', 'void *', 'void *']);
// RegisterServiceCtrlHandlerExA(lpServiceName, lpHandlerProc, lpContext)
// lpServiceName : LPCSTR -> 'str'
// lpHandlerProc : LPHANDLER_FUNCTION_EX -> 'void *'
// lpContext : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。

const lib = Deno.dlopen("ADVAPI32.dll", {
  RegisterServiceCtrlHandlerExA: { parameters: ["buffer", "pointer", "pointer"], result: "pointer" },
});
// lib.symbols.RegisterServiceCtrlHandlerExA(lpServiceName, lpHandlerProc, lpContext)
// lpServiceName : LPCSTR -> "buffer"
// lpHandlerProc : LPHANDLER_FUNCTION_EX -> "pointer"
// lpContext : void* optional -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
void* RegisterServiceCtrlHandlerExA(
    const char* lpServiceName,
    void* lpHandlerProc,
    void* lpContext);
C, "ADVAPI32.dll");
// $ffi->RegisterServiceCtrlHandlerExA(lpServiceName, lpHandlerProc, lpContext);
// lpServiceName : LPCSTR
// lpHandlerProc : LPHANDLER_FUNCTION_EX
// lpContext : void* optional
// 構造体/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 RegisterServiceCtrlHandlerExA(
        String lpServiceName,   // LPCSTR
        Callback lpHandlerProc,   // LPHANDLER_FUNCTION_EX
        Pointer lpContext   // void* optional
    );
}

@[Link("advapi32")]
lib LibADVAPI32
  fun RegisterServiceCtrlHandlerExA = RegisterServiceCtrlHandlerExA(
    lpServiceName : UInt8*,   # LPCSTR
    lpHandlerProc : Void*,   # LPHANDLER_FUNCTION_EX
    lpContext : Void*   # void* optional
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef RegisterServiceCtrlHandlerExANative = Pointer<Void> Function(Pointer<Utf8>, Pointer<Void>, Pointer<Void>);
typedef RegisterServiceCtrlHandlerExADart = Pointer<Void> Function(Pointer<Utf8>, Pointer<Void>, Pointer<Void>);
final RegisterServiceCtrlHandlerExA = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<RegisterServiceCtrlHandlerExANative, RegisterServiceCtrlHandlerExADart>('RegisterServiceCtrlHandlerExA');
// lpServiceName : LPCSTR -> Pointer<Utf8>
// lpHandlerProc : LPHANDLER_FUNCTION_EX -> Pointer<Void>
// lpContext : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function RegisterServiceCtrlHandlerExA(
  lpServiceName: PAnsiChar;   // LPCSTR
  lpHandlerProc: Pointer;   // LPHANDLER_FUNCTION_EX
  lpContext: Pointer   // void* optional
): THandle; stdcall;
  external 'ADVAPI32.dll' name 'RegisterServiceCtrlHandlerExA';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RegisterServiceCtrlHandlerExA"
  c_RegisterServiceCtrlHandlerExA :: CString -> Ptr () -> Ptr () -> IO (Ptr ())
-- lpServiceName : LPCSTR -> CString
-- lpHandlerProc : LPHANDLER_FUNCTION_EX -> Ptr ()
-- lpContext : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let registerservicectrlhandlerexa =
  foreign "RegisterServiceCtrlHandlerExA"
    (string @-> (ptr void) @-> (ptr void) @-> returning (ptr void))
(* lpServiceName : LPCSTR -> string *)
(* lpHandlerProc : LPHANDLER_FUNCTION_EX -> (ptr void) *)
(* lpContext : void* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("RegisterServiceCtrlHandlerExA" register-service-ctrl-handler-ex-a :convention :stdcall) :pointer
  (lp-service-name :string)   ; LPCSTR
  (lp-handler-proc :pointer)   ; LPHANDLER_FUNCTION_EX
  (lp-context :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $RegisterServiceCtrlHandlerExA = Win32::API::More->new('ADVAPI32',
    'HANDLE RegisterServiceCtrlHandlerExA(LPCSTR lpServiceName, LPVOID lpHandlerProc, LPVOID lpContext)');
# my $ret = $RegisterServiceCtrlHandlerExA->Call($lpServiceName, $lpHandlerProc, $lpContext);
# lpServiceName : LPCSTR -> LPCSTR
# lpHandlerProc : LPHANDLER_FUNCTION_EX -> LPVOID
# lpContext : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。