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

SERVICE_FAILURE_ACTIONSW

構造体
サイズx64: 40 バイト / x86: 20 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
dwResetPeriodDWORD4+0+0失敗が発生しない状態がこの時間続いた場合に失敗回数を 0 にリセットする、その時間(秒単位)。この値を決してリセットしないことを示すには、INFINITE を指定します。
lpRebootMsgLPWSTR8/4+8+4

SC_ACTION_REBOOT サービス コントローラー アクションに応じて再起動する前に、サーバーのユーザーにブロードキャストされるメッセージ。

この値が NULL の場合、再起動メッセージは変更されません。値が空の文字列 ("") の場合、再起動メッセージは削除され、メッセージはブロードキャストされません。

このメンバーでは、次の形式でローカライズされた文字列を指定できます。

@[path]dllname,-strID

識別子 strID を持つ文字列が dllname から読み込まれます。path は省略可能です。詳細については、RegLoadMUIString を参照してください。

Windows Server 2003 および Windows XP: ローカライズされた文字列は Windows Vista までサポートされません。

lpCommandLPWSTR8/4+16+8

SC_ACTION_RUN_COMMAND サービス コントローラー アクションに応じて CreateProcess 関数で実行するプロセスのコマンド ライン。このプロセスは、サービスと同じアカウントで実行されます。

この値が NULL の場合、コマンドは変更されません。値が空の文字列 ("") の場合、コマンドは削除され、サービスが失敗してもプログラムは実行されません。

cActionsDWORD4+24+12

lpsaActions 配列の要素数。

この値が 0 で、lpsaActions が NULL でない場合、リセット期間と失敗時のアクションの配列は削除されます。

lpsaActionsSC_ACTION*8/4+32+16

SC_ACTION 構造体の配列へのポインター。

この値が NULL の場合、cActions メンバーと dwResetPeriod メンバーは無視されます。

公式ドキュメント

サービスが失敗するたびにサービス コントローラーが実行するアクションを表します。サービスは、SERVICE_STOPPED の状態をサービス コントローラーに報告せずに終了した場合に、失敗したと見なされます。

失敗時のアクションが実行される条件を追加で構成するには、SERVICE_FAILURE_ACTIONS_FLAG を参照してください。

解説(Remarks)

サービス コントロール マネージャーは、システムの起動以降に各サービスが失敗した回数をカウントします。サービスが dwResetPeriod 秒間失敗しなかった場合、カウントは 0 にリセットされます。サービスが N 回目に失敗すると、サービス コントローラーは lpsaActions 配列の要素 [N-1] で指定されたアクションを実行します。NcActions より大きい場合、サービス コントローラーは配列の最後のアクションを繰り返します。

メモ

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

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

各言語での定義

#include <windows.h>

// SERVICE_FAILURE_ACTIONSW  (x64 40 / x86 20 バイト)
typedef struct SERVICE_FAILURE_ACTIONSW {
    DWORD dwResetPeriod;
    LPWSTR lpRebootMsg;
    LPWSTR lpCommand;
    DWORD cActions;
    SC_ACTION* lpsaActions;
} SERVICE_FAILURE_ACTIONSW;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct SERVICE_FAILURE_ACTIONSW
{
    public uint dwResetPeriod;
    public IntPtr lpRebootMsg;
    public IntPtr lpCommand;
    public uint cActions;
    public IntPtr lpsaActions;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure SERVICE_FAILURE_ACTIONSW
    Public dwResetPeriod As UInteger
    Public lpRebootMsg As IntPtr
    Public lpCommand As IntPtr
    Public cActions As UInteger
    Public lpsaActions As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class SERVICE_FAILURE_ACTIONSW(ctypes.Structure):
    _fields_ = [
        ("dwResetPeriod", wintypes.DWORD),
        ("lpRebootMsg", ctypes.c_void_p),
        ("lpCommand", ctypes.c_void_p),
        ("cActions", wintypes.DWORD),
        ("lpsaActions", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct SERVICE_FAILURE_ACTIONSW {
    pub dwResetPeriod: u32,
    pub lpRebootMsg: *mut core::ffi::c_void,
    pub lpCommand: *mut core::ffi::c_void,
    pub cActions: u32,
    pub lpsaActions: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type SERVICE_FAILURE_ACTIONSW struct {
	dwResetPeriod uint32
	lpRebootMsg uintptr
	lpCommand uintptr
	cActions uint32
	lpsaActions uintptr
}
type
  SERVICE_FAILURE_ACTIONSW = record
    dwResetPeriod: DWORD;
    lpRebootMsg: Pointer;
    lpCommand: Pointer;
    cActions: DWORD;
    lpsaActions: Pointer;
  end;
const SERVICE_FAILURE_ACTIONSW = extern struct {
    dwResetPeriod: u32,
    lpRebootMsg: ?*anyopaque,
    lpCommand: ?*anyopaque,
    cActions: u32,
    lpsaActions: ?*anyopaque,
};
type
  SERVICE_FAILURE_ACTIONSW {.bycopy.} = object
    dwResetPeriod: uint32
    lpRebootMsg: pointer
    lpCommand: pointer
    cActions: uint32
    lpsaActions: pointer
struct SERVICE_FAILURE_ACTIONSW
{
    uint dwResetPeriod;
    void* lpRebootMsg;
    void* lpCommand;
    uint cActions;
    void* lpsaActions;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; SERVICE_FAILURE_ACTIONSW サイズ: 20 バイト(x86)
dim st, 5    ; 4byte整数×5(構造体サイズ 20 / 4 切り上げ)
; dwResetPeriod : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; lpRebootMsg : LPWSTR (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; lpCommand : LPWSTR (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; cActions : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; lpsaActions : SC_ACTION* (+16, 4byte)  varptr(st)+16 を基点に操作(4byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; SERVICE_FAILURE_ACTIONSW サイズ: 40 バイト(x64)
dim st, 10    ; 4byte整数×10(構造体サイズ 40 / 4 切り上げ)
; dwResetPeriod : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; lpRebootMsg : LPWSTR (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; lpCommand : LPWSTR (+16, 8byte)  qpoke st,16,値 / qpeek(st,16)  ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; cActions : DWORD (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; lpsaActions : SC_ACTION* (+32, 8byte)  varptr(st)+32 を基点に操作(8byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global SERVICE_FAILURE_ACTIONSW
    #field int dwResetPeriod
    #field intptr lpRebootMsg
    #field intptr lpCommand
    #field int cActions
    #field intptr lpsaActions
#endstruct

stdim st, SERVICE_FAILURE_ACTIONSW        ; NSTRUCT 変数を確保
st->dwResetPeriod = 100
mes "dwResetPeriod=" + st->dwResetPeriod