RegisterServiceCtrlHandlerW
関数シグネチャ
// ADVAPI32.dll (Unicode / -W)
#include <windows.h>
SERVICE_STATUS_HANDLE RegisterServiceCtrlHandlerW(
LPCWSTR lpServiceName,
LPHANDLER_FUNCTION lpHandlerProc
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| lpServiceName | LPCWSTR | in | 呼び出し元スレッドが実行するサービスの名前です。これは、サービスを作成する際にサービス制御プログラムが CreateService 関数で指定したサービス名です。 サービスの種類が SERVICE_WIN32_OWN_PROCESS の場合、プロセス内に登録されているサービスは 1 つだけであるため、この関数は指定された名前が有効かどうかを検証しません。 |
| lpHandlerProc | LPHANDLER_FUNCTION | in | 登録するハンドラー関数へのポインターです。詳細については、 Handler を参照してください。 |
戻り値の型: SERVICE_STATUS_HANDLE
公式ドキュメント
サービス制御要求を処理する関数を登録します。(Unicode)
戻り値
関数が成功した場合、戻り値はサービス状態ハンドルです。
関数が失敗した場合、戻り値はゼロです。拡張エラー情報を取得するには、 GetLastError を呼び出します。
次のエラーコードはサービス制御マネージャーによって設定される場合があります。
| 戻りコード | 説明 |
|---|---|
| ANSI 文字列パラメーターを Unicode に変換するための十分なメモリがありません。このエラーは Unicode 文字列パラメーターでは発生しません。 | |
| プロセスが StartServiceCtrlDispatcher 関数を呼び出したときに、サービスエントリが正しく指定されていませんでした。 |
解説(Remarks)
新しいサービスの ServiceMain 関数は、直ちに RegisterServiceCtrlHandler 関数を呼び出して、制御ディスパッチャーに制御ハンドラー関数を登録する必要があります。これにより、制御ディスパッチャーはこのサービスに対する制御要求を受信したときに、指定された関数を呼び出すことができます。指定可能な制御コードの一覧については、Handler を参照してください。呼び出し元プロセスのスレッドは、この関数が返すサービス状態ハンドルを使用して、後続の SetServiceStatus 関数の呼び出しでサービスを識別できます。
RegisterServiceCtrlHandler 関数は、最初の SetServiceStatus の呼び出しより前に呼び出す必要があります。これは、RegisterServiceCtrlHandler が呼び出し元に使用させるサービス状態ハンドルを返すことで、他のサービスがこのサービスの状態を誤って設定しないようにするためです。さらに、サービスが SetServiceStatus 関数を通じて受け付ける制御を指定するまでに、制御要求を受信できるように制御ハンドラーが配置されている必要があります。
制御ハンドラー関数が制御要求とともに呼び出された場合、サービスは、サービスの状態が変化したとき(サービスが停止やシャットダウンの制御を処理しているときなど)に限り、 SetServiceStatus を呼び出してサービス制御マネージャーに状態を報告する必要があります。サービスの状態が変化していない場合は、サービス制御マネージャーに状態を報告すべきではありません。
サービス状態ハンドルを閉じる必要はありません。
例
例については、 Writing a ServiceMain Function を参照してください。
winsvc.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして RegisterServiceCtrlHandler を定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーやランタイムエラーを引き起こす不一致が生じる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// ADVAPI32.dll (Unicode / -W)
#include <windows.h>
SERVICE_STATUS_HANDLE RegisterServiceCtrlHandlerW(
LPCWSTR lpServiceName,
LPHANDLER_FUNCTION lpHandlerProc
);[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr RegisterServiceCtrlHandlerW(
[MarshalAs(UnmanagedType.LPWStr)] string lpServiceName, // LPCWSTR
IntPtr lpHandlerProc // LPHANDLER_FUNCTION
);<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function RegisterServiceCtrlHandlerW(
<MarshalAs(UnmanagedType.LPWStr)> lpServiceName As String, ' LPCWSTR
lpHandlerProc As IntPtr ' LPHANDLER_FUNCTION
) As IntPtr
End Function' lpServiceName : LPCWSTR
' lpHandlerProc : LPHANDLER_FUNCTION
Declare PtrSafe Function RegisterServiceCtrlHandlerW Lib "advapi32" ( _
ByVal lpServiceName As LongPtr, _
ByVal lpHandlerProc As LongPtr) As LongPtr
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
RegisterServiceCtrlHandlerW = ctypes.windll.advapi32.RegisterServiceCtrlHandlerW
RegisterServiceCtrlHandlerW.restype = ctypes.c_void_p
RegisterServiceCtrlHandlerW.argtypes = [
wintypes.LPCWSTR, # lpServiceName : LPCWSTR
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')
RegisterServiceCtrlHandlerW = Fiddle::Function.new(
lib['RegisterServiceCtrlHandlerW'],
[
Fiddle::TYPE_VOIDP, # lpServiceName : LPCWSTR
Fiddle::TYPE_VOIDP, # lpHandlerProc : LPHANDLER_FUNCTION
],
Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "advapi32")]
extern "system" {
fn RegisterServiceCtrlHandlerW(
lpServiceName: *const u16, // LPCWSTR
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.Unicode, SetLastError = true)]
public static extern IntPtr RegisterServiceCtrlHandlerW([MarshalAs(UnmanagedType.LPWStr)] string lpServiceName, IntPtr lpHandlerProc);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegisterServiceCtrlHandlerW' -Namespace Win32 -PassThru
# $api::RegisterServiceCtrlHandlerW(lpServiceName, lpHandlerProc)#uselib "ADVAPI32.dll"
#func global RegisterServiceCtrlHandlerW "RegisterServiceCtrlHandlerW" wptr, wptr
; RegisterServiceCtrlHandlerW lpServiceName, lpHandlerProc ; 戻り値は stat
; lpServiceName : LPCWSTR -> "wptr"
; lpHandlerProc : LPHANDLER_FUNCTION -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "ADVAPI32.dll"
#cfunc global RegisterServiceCtrlHandlerW "RegisterServiceCtrlHandlerW" wstr, sptr
; res = RegisterServiceCtrlHandlerW(lpServiceName, lpHandlerProc)
; lpServiceName : LPCWSTR -> "wstr"
; lpHandlerProc : LPHANDLER_FUNCTION -> "sptr"; SERVICE_STATUS_HANDLE RegisterServiceCtrlHandlerW(LPCWSTR lpServiceName, LPHANDLER_FUNCTION lpHandlerProc)
#uselib "ADVAPI32.dll"
#cfunc global RegisterServiceCtrlHandlerW "RegisterServiceCtrlHandlerW" wstr, intptr
; res = RegisterServiceCtrlHandlerW(lpServiceName, lpHandlerProc)
; lpServiceName : LPCWSTR -> "wstr"
; lpHandlerProc : LPHANDLER_FUNCTION -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
procRegisterServiceCtrlHandlerW = advapi32.NewProc("RegisterServiceCtrlHandlerW")
)
// lpServiceName (LPCWSTR), lpHandlerProc (LPHANDLER_FUNCTION)
r1, _, err := procRegisterServiceCtrlHandlerW.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpServiceName))),
uintptr(lpHandlerProc),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // SERVICE_STATUS_HANDLEfunction RegisterServiceCtrlHandlerW(
lpServiceName: PWideChar; // LPCWSTR
lpHandlerProc: Pointer // LPHANDLER_FUNCTION
): THandle; stdcall;
external 'ADVAPI32.dll' name 'RegisterServiceCtrlHandlerW';result := DllCall("ADVAPI32\RegisterServiceCtrlHandlerW"
, "WStr", lpServiceName ; LPCWSTR
, "Ptr", lpHandlerProc ; LPHANDLER_FUNCTION
, "Ptr") ; return: SERVICE_STATUS_HANDLE●RegisterServiceCtrlHandlerW(lpServiceName, lpHandlerProc) = DLL("ADVAPI32.dll", "void* RegisterServiceCtrlHandlerW(char*, void*)")
# 呼び出し: RegisterServiceCtrlHandlerW(lpServiceName, lpHandlerProc)
# lpServiceName : LPCWSTR -> "char*"
# lpHandlerProc : LPHANDLER_FUNCTION -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "advapi32" fn RegisterServiceCtrlHandlerW(
lpServiceName: [*c]const u16, // LPCWSTR
lpHandlerProc: ?*anyopaque // LPHANDLER_FUNCTION
) callconv(std.os.windows.WINAPI) ?*anyopaque;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc RegisterServiceCtrlHandlerW(
lpServiceName: WideCString, # LPCWSTR
lpHandlerProc: pointer # LPHANDLER_FUNCTION
): pointer {.importc: "RegisterServiceCtrlHandlerW", stdcall, dynlib: "ADVAPI32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "advapi32");
extern(Windows)
void* RegisterServiceCtrlHandlerW(
const(wchar)* lpServiceName, // LPCWSTR
void* lpHandlerProc // LPHANDLER_FUNCTION
);ccall((:RegisterServiceCtrlHandlerW, "ADVAPI32.dll"), stdcall, Ptr{Cvoid},
(Cwstring, Ptr{Cvoid}),
lpServiceName, lpHandlerProc)
# lpServiceName : LPCWSTR -> Cwstring
# lpHandlerProc : LPHANDLER_FUNCTION -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
void* RegisterServiceCtrlHandlerW(
const uint16_t* lpServiceName,
void* lpHandlerProc);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.RegisterServiceCtrlHandlerW(lpServiceName, lpHandlerProc)
-- lpServiceName : LPCWSTR
-- lpHandlerProc : LPHANDLER_FUNCTION
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const RegisterServiceCtrlHandlerW = lib.func('__stdcall', 'RegisterServiceCtrlHandlerW', 'void *', ['str16', 'void *']);
// RegisterServiceCtrlHandlerW(lpServiceName, lpHandlerProc)
// lpServiceName : LPCWSTR -> 'str16'
// lpHandlerProc : LPHANDLER_FUNCTION -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。const lib = Deno.dlopen("ADVAPI32.dll", {
RegisterServiceCtrlHandlerW: { parameters: ["buffer", "pointer"], result: "pointer" },
});
// lib.symbols.RegisterServiceCtrlHandlerW(lpServiceName, lpHandlerProc)
// lpServiceName : LPCWSTR -> "buffer"
// lpHandlerProc : LPHANDLER_FUNCTION -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
void* RegisterServiceCtrlHandlerW(
const uint16_t* lpServiceName,
void* lpHandlerProc);
C, "ADVAPI32.dll");
// $ffi->RegisterServiceCtrlHandlerW(lpServiceName, lpHandlerProc);
// lpServiceName : LPCWSTR
// 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.UNICODE_OPTIONS);
Pointer RegisterServiceCtrlHandlerW(
WString lpServiceName, // LPCWSTR
Callback lpHandlerProc // LPHANDLER_FUNCTION
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("advapi32")]
lib LibADVAPI32
fun RegisterServiceCtrlHandlerW = RegisterServiceCtrlHandlerW(
lpServiceName : UInt16*, # LPCWSTR
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 RegisterServiceCtrlHandlerWNative = Pointer<Void> Function(Pointer<Utf16>, Pointer<Void>);
typedef RegisterServiceCtrlHandlerWDart = Pointer<Void> Function(Pointer<Utf16>, Pointer<Void>);
final RegisterServiceCtrlHandlerW = DynamicLibrary.open('ADVAPI32.dll')
.lookupFunction<RegisterServiceCtrlHandlerWNative, RegisterServiceCtrlHandlerWDart>('RegisterServiceCtrlHandlerW');
// lpServiceName : LPCWSTR -> Pointer<Utf16>
// lpHandlerProc : LPHANDLER_FUNCTION -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function RegisterServiceCtrlHandlerW(
lpServiceName: PWideChar; // LPCWSTR
lpHandlerProc: Pointer // LPHANDLER_FUNCTION
): THandle; stdcall;
external 'ADVAPI32.dll' name 'RegisterServiceCtrlHandlerW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "RegisterServiceCtrlHandlerW"
c_RegisterServiceCtrlHandlerW :: CWString -> Ptr () -> IO (Ptr ())
-- lpServiceName : LPCWSTR -> CWString
-- lpHandlerProc : LPHANDLER_FUNCTION -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let registerservicectrlhandlerw =
foreign "RegisterServiceCtrlHandlerW"
((ptr uint16_t) @-> (ptr void) @-> returning (ptr void))
(* lpServiceName : LPCWSTR -> (ptr uint16_t) *)
(* 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 ("RegisterServiceCtrlHandlerW" register-service-ctrl-handler-w :convention :stdcall) :pointer
(lp-service-name (:string :encoding :utf-16le)) ; LPCWSTR
(lp-handler-proc :pointer)) ; LPHANDLER_FUNCTION
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $RegisterServiceCtrlHandlerW = Win32::API::More->new('ADVAPI32',
'HANDLE RegisterServiceCtrlHandlerW(LPCWSTR lpServiceName, LPVOID lpHandlerProc)');
# my $ret = $RegisterServiceCtrlHandlerW->Call($lpServiceName, $lpHandlerProc);
# lpServiceName : LPCWSTR -> LPCWSTR
# lpHandlerProc : LPHANDLER_FUNCTION -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f RegisterServiceCtrlHandlerA (ANSI版) — サービスの制御要求ハンドラ関数を登録する。
- f RegisterServiceCtrlHandlerExW — コンテキスト付きでサービス制御ハンドラ関数を登録する。
- f CreateServiceW — 新しいサービスを作成しSCMデータベースに登録する。
- c LPSERVICE_MAIN_FUNCTIONW
- f SetServiceStatus — サービスの状態をSCMに報告する。