ホーム › System.Services › SetServiceStatus

SetServiceStatus

関数

サービスの状態をSCMに報告する。

DLLADVAPI32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL SetServiceStatus(
    SERVICE_STATUS_HANDLE hServiceStatus,
    SERVICE_STATUS* lpServiceStatus
);

パラメーター

名前	型	方向	説明
hServiceStatus	SERVICE_STATUS_HANDLE	in	現在のサービスのステータス情報構造体へのハンドルです。このハンドルは RegisterServiceCtrlHandlerEx 関数から返されます。
lpServiceStatus	SERVICE_STATUS*	in	呼び出し元のサービスの最新のステータス情報を格納する SERVICE_STATUS 構造体へのポインターです。

戻り値の型: BOOL

公式ドキュメント

呼び出し元のサービスについて、サービスコントロールマネージャーが保持するステータス情報を更新します。

戻り値

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

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

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

戻り値コード	説明
ERROR_INVALID_DATA	指定されたサービスステータス構造体が無効です。
ERROR_INVALID_HANDLE	指定されたハンドルが無効です。

解説(Remarks)

ServiceMain 関数は、まず RegisterServiceCtrlHandlerEx 関数を呼び出してサービスの SERVICE_STATUS_HANDLE を取得します。その後すぐに SetServiceStatus 関数を呼び出し、ステータスが SERVICE_START_PENDING であることをサービスコントロールマネージャーに通知します。初期化中、サービスは処理が進行中であるものの追加の時間が必要であることを示すために、更新されたステータスを提供できます。よくあるバグとして、メインスレッドが初期化を実行する一方で、別のスレッドが SetServiceStatus を呼び出し続けて、サービスコントロールマネージャーがサービスをハングと見なすのを防ごうとするものがあります。しかし、メインスレッドがハングした場合、ワーカースレッドはメインスレッドが進行中であると報告し続けるため、サービスの開始は無限ループに陥ってしまいます。

コントロール要求を処理した後、サービスの Handler 関数は、サービスのステータスが変化した場合に SetServiceStatus を呼び出して新しいステータスをサービスコントロールマネージャーに報告する必要があります。これが必要となるのは、停止やシャットダウンのコントロールを処理しているときなど、サービスの状態が変化している場合のみです。サービスは、回復可能なエラーにより停止しなければならない場合など、いつでもサービスの任意のスレッドからこの関数を使用して、状態変化をサービスコントロールマネージャーに通知することもできます。

サービスがこの関数を呼び出せるのは、 RegisterServiceCtrlHandlerEx を呼び出してサービスステータスハンドルを取得した後のみです。

サービスが dwCurrentState メンバーを SERVICE_STOPPED に、dwWin32ExitCode メンバーを 0 以外の値に設定して SetServiceStatus を呼び出した場合、システムイベントログに次のエントリが書き込まれます。

   Event ID    = 7023
   Source      = Service Control Manager
   Type        = Error
   Description = <ServiceName> terminated with the following error:
                 <ExitCode>.

この関数を呼び出す際のベストプラクティスは次のとおりです。

SERVICE_STATUS 構造体のすべてのフィールドを初期化し、保留状態に対して有効なチェックポイント値および待機ヒント値が設定されていることを確認してください。妥当な待機ヒントを使用してください。
ステータスが SERVICE_START_PENDING の間はコントロールを受け付ける登録を行わないでください。さもないとサービスがクラッシュする可能性があります。初期化の完了後に SERVICE_CONTROL_STOP コードを受け付けてください。
チェックポイント値および待機ヒント値を指定してこの関数を呼び出すのは、保留中の開始、停止、一時停止、または続行の操作に関連するタスクが進行している場合のみにしてください。そうでない場合、SCM はサービスがハングしているかどうかを検出できません。
ServiceMain が失敗した場合は、適切な終了コードを指定して停止状態に移行してください。
ステータスが SERVICE_STOPPED の場合は、必要なすべてのクリーンアップを実行し、SetServiceStatus を一度だけ呼び出してください。この関数は SCM に対して LRPC 呼び出しを行います。SERVICE_STOPPED 状態でこの関数を最初に呼び出すと RPC コンテキストハンドルが閉じられ、その後の呼び出しはプロセスのクラッシュを引き起こす可能性があります。
SERVICE_STOPPED を指定して SetServiceStatus を呼び出した後は、追加の作業を実行しようとしないでください。サービスプロセスはいつでも終了される可能性があるためです。

例

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

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

各言語での呼び出し定義

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

BOOL SetServiceStatus(
    SERVICE_STATUS_HANDLE hServiceStatus,
    SERVICE_STATUS* lpServiceStatus
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetServiceStatus(
    IntPtr hServiceStatus,   // SERVICE_STATUS_HANDLE
    IntPtr lpServiceStatus   // SERVICE_STATUS*
);

<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetServiceStatus(
    hServiceStatus As IntPtr,   ' SERVICE_STATUS_HANDLE
    lpServiceStatus As IntPtr   ' SERVICE_STATUS*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hServiceStatus : SERVICE_STATUS_HANDLE
' lpServiceStatus : SERVICE_STATUS*
Declare PtrSafe Function SetServiceStatus Lib "advapi32" ( _
    ByVal hServiceStatus As LongPtr, _
    ByVal lpServiceStatus As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetServiceStatus = ctypes.windll.advapi32.SetServiceStatus
SetServiceStatus.restype = wintypes.BOOL
SetServiceStatus.argtypes = [
    wintypes.HANDLE,  # hServiceStatus : SERVICE_STATUS_HANDLE
    ctypes.c_void_p,  # lpServiceStatus : SERVICE_STATUS*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
SetServiceStatus = Fiddle::Function.new(
  lib['SetServiceStatus'],
  [
    Fiddle::TYPE_VOIDP,  # hServiceStatus : SERVICE_STATUS_HANDLE
    Fiddle::TYPE_VOIDP,  # lpServiceStatus : SERVICE_STATUS*
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn SetServiceStatus(
        hServiceStatus: *mut core::ffi::c_void,  // SERVICE_STATUS_HANDLE
        lpServiceStatus: *mut SERVICE_STATUS  // SERVICE_STATUS*
    ) -> 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 SetServiceStatus(IntPtr hServiceStatus, IntPtr lpServiceStatus);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_SetServiceStatus' -Namespace Win32 -PassThru
# $api::SetServiceStatus(hServiceStatus, lpServiceStatus)

#uselib "ADVAPI32.dll"
#func global SetServiceStatus "SetServiceStatus" sptr, sptr
; SetServiceStatus hServiceStatus, varptr(lpServiceStatus)   ; 戻り値は stat
; hServiceStatus : SERVICE_STATUS_HANDLE -> "sptr"
; lpServiceStatus : SERVICE_STATUS* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global SetServiceStatus "SetServiceStatus" sptr, var
; res = SetServiceStatus(hServiceStatus, lpServiceStatus)
; hServiceStatus : SERVICE_STATUS_HANDLE -> "sptr"
; lpServiceStatus : SERVICE_STATUS* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global SetServiceStatus "SetServiceStatus" sptr, sptr
; res = SetServiceStatus(hServiceStatus, varptr(lpServiceStatus))
; hServiceStatus : SERVICE_STATUS_HANDLE -> "sptr"
; lpServiceStatus : SERVICE_STATUS* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。