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

RmShutdown

関数
影響を受けるアプリやサービスを停止する。
DLLrstrtmgr.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

WIN32_ERROR RmShutdown(
    DWORD dwSessionHandle,
    DWORD lActionFlags,
    RM_WRITE_STATUS_CALLBACK fnStatus   // optional
);

パラメーター

名前型方向説明
dwSessionHandleDWORDin既存の Restart Manager セッションのハンドル。
lActionFlagsDWORDin

コンポーネントのシャットダウン方法を構成する 1 つ以上の RM_SHUTDOWN_TYPE オプション。次の値を OR 演算子で組み合わせることで、すべてのアプリケーションが再起動用に登録されている場合に限り、応答しないアプリケーションおよびサービスを強制的にシャットダウンするよう指定できます。

値 意味
RmForceShutdown
0x1
タイムアウト期間の経過後、応答しないアプリケーションおよびサービスを強制的にシャットダウンします。シャットダウン要求に応答しないアプリケーションは 30 秒以内に強制的にシャットダウンされます。シャットダウン要求に応答しないサービスは 20 秒後に強制的にシャットダウンされます。
RmShutdownOnlyRegistered
0x10
すべてのアプリケーションが RegisterApplicationRestart 関数によって再起動用に登録されている場合に限り、アプリケーションをシャットダウンします。再起動できないプロセスまたはサービスが 1 つでもある場合、プロセスおよびサービスは一切シャットダウンされません。
fnStatusRM_WRITE_STATUS_CALLBACKinoptionalこの関数の実行中に詳細な状態を通知するために使用される RM_WRITE_STATUS_CALLBACK 関数へのポインター。NULL の場合、状態は通知されません。

戻り値の型: WIN32_ERROR

公式ドキュメント

アプリケーションのシャットダウンを開始します。

戻り値

最後に受け取ったエラーです。この関数は、Winerror.h で定義されている システム エラー コード のいずれかを返すことがあります。

値 意味
ERROR_SUCCESS
0
すべてのシャットダウン、再起動、およびコールバックの操作が正常に完了しました。
ERROR_FAIL_NOACTION_REBOOT
350
シャットダウン処理は実行されませんでした。1 つ以上のプロセスまたはサービスをシャットダウンするには、システムの再起動が必要です。このエラー コードは、いずれかのアプリケーションをシャットダウンする前にシステムの再起動が必要であることを Restart Manager が検出した場合に返されます。
ERROR_FAIL_SHUTDOWN
351
一部のアプリケーションをシャットダウンできませんでした。RmGetList 関数が返す RM_PROCESS_INFO 構造体の AppStatus に、更新された状態情報が格納されます。
ERROR_CANCELLED
1223
操作のキャンセル要求が成功した場合に RmShutdown 関数から返されるエラー値です。
ERROR_SEM_TIMEOUT
121
Restart Manager の関数が、規定の時間内にレジストリ書き込み用のミューテックスを取得できませんでした。これ以降も Restart Manager の使用は失敗する可能性が高いため、システムの再起動を推奨します。
ERROR_BAD_ARGUMENTS
160
1 つ以上の引数が正しくありません。null 以外かつ 0 以外の値が必要なパラメーターに NULL ポインターまたは 0 が渡された場合に、Restart Manager の関数から返されるエラー値です。
ERROR_WRITE_FAULT
29
レジストリの読み取りまたは書き込みを実行できませんでした。
ERROR_OUTOFMEMORY
14
使用可能なメモリが不足しているため、Restart Manager の操作を完了できませんでした。
ERROR_INVALID_HANDLE
6
指定されたハンドルに対応する Restart Manager セッションが存在しません。

解説(Remarks)

RmShutdown 関数は、プロセスのシャットダウンを試みる前に RmGetList を呼び出し、登録済みリソースを現在使用しているプロセスの一覧を更新します。その後 RmShutdown 関数は、最新の一覧に基づいて、登録済みリソースを使用しているプロセスのシャットダウンを試みます。RmShutdown 関数は、RmGetList 関数が返す RM_PROCESS_INFO 構造体の AppStatus メンバーを、詳細な状態情報で更新します。

Restart Manager は、ユーザー セッションやターミナル セッションを分離する特権を尊重します。LocalSystem 特権でサービスとして実行されているインストーラーは、別のユーザー セッションやターミナル セッション内のアプリケーションをシャットダウンまたは再起動することはできません。インストーラーは、他のセッションで実行中のアプリケーションをシャットダウンおよび再起動するための独自の方法を実装する必要があります。その方法の 1 つとして、シャットダウンおよび再起動の操作を行うために、他のセッションで新しいインストーラー プロセスを起動する方法があります。

インストーラーは、すべてのアプリケーションおよびサービスをシャットダウンできなかったことを示すエラーを RmShutdown 関数が返した場合でも、必ず RmRestart 関数を使用してアプリケーションおよびサービスを再起動してください。

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

各言語での呼び出し定義

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

WIN32_ERROR RmShutdown(
    DWORD dwSessionHandle,
    DWORD lActionFlags,
    RM_WRITE_STATUS_CALLBACK fnStatus   // optional
);
[DllImport("rstrtmgr.dll", ExactSpelling = true)]
static extern uint RmShutdown(
    uint dwSessionHandle,   // DWORD
    uint lActionFlags,   // DWORD
    IntPtr fnStatus   // RM_WRITE_STATUS_CALLBACK optional
);
<DllImport("rstrtmgr.dll", ExactSpelling:=True)>
Public Shared Function RmShutdown(
    dwSessionHandle As UInteger,   ' DWORD
    lActionFlags As UInteger,   ' DWORD
    fnStatus As IntPtr   ' RM_WRITE_STATUS_CALLBACK optional
) As UInteger
End Function
' dwSessionHandle : DWORD
' lActionFlags : DWORD
' fnStatus : RM_WRITE_STATUS_CALLBACK optional
Declare PtrSafe Function RmShutdown Lib "rstrtmgr" ( _
    ByVal dwSessionHandle As Long, _
    ByVal lActionFlags As Long, _
    ByVal fnStatus As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RmShutdown = ctypes.windll.rstrtmgr.RmShutdown
RmShutdown.restype = wintypes.DWORD
RmShutdown.argtypes = [
    wintypes.DWORD,  # dwSessionHandle : DWORD
    wintypes.DWORD,  # lActionFlags : DWORD
    ctypes.c_void_p,  # fnStatus : RM_WRITE_STATUS_CALLBACK optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('rstrtmgr.dll')
RmShutdown = Fiddle::Function.new(
  lib['RmShutdown'],
  [
    -Fiddle::TYPE_INT,  # dwSessionHandle : DWORD
    -Fiddle::TYPE_INT,  # lActionFlags : DWORD
    Fiddle::TYPE_VOIDP,  # fnStatus : RM_WRITE_STATUS_CALLBACK optional
  ],
  -Fiddle::TYPE_INT)
#[link(name = "rstrtmgr")]
extern "system" {
    fn RmShutdown(
        dwSessionHandle: u32,  // DWORD
        lActionFlags: u32,  // DWORD
        fnStatus: *const core::ffi::c_void  // RM_WRITE_STATUS_CALLBACK optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("rstrtmgr.dll")]
public static extern uint RmShutdown(uint dwSessionHandle, uint lActionFlags, IntPtr fnStatus);
"@
$api = Add-Type -MemberDefinition $sig -Name 'rstrtmgr_RmShutdown' -Namespace Win32 -PassThru
# $api::RmShutdown(dwSessionHandle, lActionFlags, fnStatus)
#uselib "rstrtmgr.dll"
#func global RmShutdown "RmShutdown" sptr, sptr, sptr
; RmShutdown dwSessionHandle, lActionFlags, fnStatus   ; 戻り値は stat
; dwSessionHandle : DWORD -> "sptr"
; lActionFlags : DWORD -> "sptr"
; fnStatus : RM_WRITE_STATUS_CALLBACK optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "rstrtmgr.dll"
#cfunc global RmShutdown "RmShutdown" int, int, sptr
; res = RmShutdown(dwSessionHandle, lActionFlags, fnStatus)
; dwSessionHandle : DWORD -> "int"
; lActionFlags : DWORD -> "int"
; fnStatus : RM_WRITE_STATUS_CALLBACK optional -> "sptr"
; WIN32_ERROR RmShutdown(DWORD dwSessionHandle, DWORD lActionFlags, RM_WRITE_STATUS_CALLBACK fnStatus)
#uselib "rstrtmgr.dll"
#cfunc global RmShutdown "RmShutdown" int, int, intptr
; res = RmShutdown(dwSessionHandle, lActionFlags, fnStatus)
; dwSessionHandle : DWORD -> "int"
; lActionFlags : DWORD -> "int"
; fnStatus : RM_WRITE_STATUS_CALLBACK optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	rstrtmgr = windows.NewLazySystemDLL("rstrtmgr.dll")
	procRmShutdown = rstrtmgr.NewProc("RmShutdown")
)

// dwSessionHandle (DWORD), lActionFlags (DWORD), fnStatus (RM_WRITE_STATUS_CALLBACK optional)
r1, _, err := procRmShutdown.Call(
	uintptr(dwSessionHandle),
	uintptr(lActionFlags),
	uintptr(fnStatus),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function RmShutdown(
  dwSessionHandle: DWORD;   // DWORD
  lActionFlags: DWORD;   // DWORD
  fnStatus: Pointer   // RM_WRITE_STATUS_CALLBACK optional
): DWORD; stdcall;
  external 'rstrtmgr.dll' name 'RmShutdown';
result := DllCall("rstrtmgr\RmShutdown"
    , "UInt", dwSessionHandle   ; DWORD
    , "UInt", lActionFlags   ; DWORD
    , "Ptr", fnStatus   ; RM_WRITE_STATUS_CALLBACK optional
    , "UInt")   ; return: WIN32_ERROR
●RmShutdown(dwSessionHandle, lActionFlags, fnStatus) = DLL("rstrtmgr.dll", "dword RmShutdown(dword, dword, void*)")
# 呼び出し: RmShutdown(dwSessionHandle, lActionFlags, fnStatus)
# dwSessionHandle : DWORD -> "dword"
# lActionFlags : DWORD -> "dword"
# fnStatus : RM_WRITE_STATUS_CALLBACK optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "rstrtmgr" fn RmShutdown(
    dwSessionHandle: u32, // DWORD
    lActionFlags: u32, // DWORD
    fnStatus: ?*anyopaque // RM_WRITE_STATUS_CALLBACK optional
) callconv(std.os.windows.WINAPI) u32;
proc RmShutdown(
    dwSessionHandle: uint32,  # DWORD
    lActionFlags: uint32,  # DWORD
    fnStatus: pointer  # RM_WRITE_STATUS_CALLBACK optional
): uint32 {.importc: "RmShutdown", stdcall, dynlib: "rstrtmgr.dll".}
pragma(lib, "rstrtmgr");
extern(Windows)
uint RmShutdown(
    uint dwSessionHandle,   // DWORD
    uint lActionFlags,   // DWORD
    void* fnStatus   // RM_WRITE_STATUS_CALLBACK optional
);
ccall((:RmShutdown, "rstrtmgr.dll"), stdcall, UInt32,
      (UInt32, UInt32, Ptr{Cvoid}),
      dwSessionHandle, lActionFlags, fnStatus)
# dwSessionHandle : DWORD -> UInt32
# lActionFlags : DWORD -> UInt32
# fnStatus : RM_WRITE_STATUS_CALLBACK optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t RmShutdown(
    uint32_t dwSessionHandle,
    uint32_t lActionFlags,
    void* fnStatus);
]]
local rstrtmgr = ffi.load("rstrtmgr")
-- rstrtmgr.RmShutdown(dwSessionHandle, lActionFlags, fnStatus)
-- dwSessionHandle : DWORD
-- lActionFlags : DWORD
-- fnStatus : RM_WRITE_STATUS_CALLBACK optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('rstrtmgr.dll');
const RmShutdown = lib.func('__stdcall', 'RmShutdown', 'uint32_t', ['uint32_t', 'uint32_t', 'void *']);
// RmShutdown(dwSessionHandle, lActionFlags, fnStatus)
// dwSessionHandle : DWORD -> 'uint32_t'
// lActionFlags : DWORD -> 'uint32_t'
// fnStatus : RM_WRITE_STATUS_CALLBACK optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("rstrtmgr.dll", {
  RmShutdown: { parameters: ["u32", "u32", "pointer"], result: "u32" },
});
// lib.symbols.RmShutdown(dwSessionHandle, lActionFlags, fnStatus)
// dwSessionHandle : DWORD -> "u32"
// lActionFlags : DWORD -> "u32"
// fnStatus : RM_WRITE_STATUS_CALLBACK optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t RmShutdown(
    uint32_t dwSessionHandle,
    uint32_t lActionFlags,
    void* fnStatus);
C, "rstrtmgr.dll");
// $ffi->RmShutdown(dwSessionHandle, lActionFlags, fnStatus);
// dwSessionHandle : DWORD
// lActionFlags : DWORD
// fnStatus : RM_WRITE_STATUS_CALLBACK 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 Rstrtmgr extends StdCallLibrary {
    Rstrtmgr INSTANCE = Native.load("rstrtmgr", Rstrtmgr.class);
    int RmShutdown(
        int dwSessionHandle,   // DWORD
        int lActionFlags,   // DWORD
        Callback fnStatus   // RM_WRITE_STATUS_CALLBACK optional
    );
}
@[Link("rstrtmgr")]
lib Librstrtmgr
  fun RmShutdown = RmShutdown(
    dwSessionHandle : UInt32,   # DWORD
    lActionFlags : UInt32,   # DWORD
    fnStatus : Void*   # RM_WRITE_STATUS_CALLBACK optional
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef RmShutdownNative = Uint32 Function(Uint32, Uint32, Pointer<Void>);
typedef RmShutdownDart = int Function(int, int, Pointer<Void>);
final RmShutdown = DynamicLibrary.open('rstrtmgr.dll')
    .lookupFunction<RmShutdownNative, RmShutdownDart>('RmShutdown');
// dwSessionHandle : DWORD -> Uint32
// lActionFlags : DWORD -> Uint32
// fnStatus : RM_WRITE_STATUS_CALLBACK optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RmShutdown(
  dwSessionHandle: DWORD;   // DWORD
  lActionFlags: DWORD;   // DWORD
  fnStatus: Pointer   // RM_WRITE_STATUS_CALLBACK optional
): DWORD; stdcall;
  external 'rstrtmgr.dll' name 'RmShutdown';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RmShutdown"
  c_RmShutdown :: Word32 -> Word32 -> Ptr () -> IO Word32
-- dwSessionHandle : DWORD -> Word32
-- lActionFlags : DWORD -> Word32
-- fnStatus : RM_WRITE_STATUS_CALLBACK optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rmshutdown =
  foreign "RmShutdown"
    (uint32_t @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* dwSessionHandle : DWORD -> uint32_t *)
(* lActionFlags : DWORD -> uint32_t *)
(* fnStatus : RM_WRITE_STATUS_CALLBACK optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rstrtmgr (t "rstrtmgr.dll"))
(cffi:use-foreign-library rstrtmgr)

(cffi:defcfun ("RmShutdown" rm-shutdown :convention :stdcall) :uint32
  (dw-session-handle :uint32)   ; DWORD
  (l-action-flags :uint32)   ; DWORD
  (fn-status :pointer))   ; RM_WRITE_STATUS_CALLBACK optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RmShutdown = Win32::API::More->new('rstrtmgr',
    'DWORD RmShutdown(DWORD dwSessionHandle, DWORD lActionFlags, LPVOID fnStatus)');
# my $ret = $RmShutdown->Call($dwSessionHandle, $lActionFlags, $fnStatus);
# dwSessionHandle : DWORD -> DWORD
# lActionFlags : DWORD -> DWORD
# fnStatus : RM_WRITE_STATUS_CALLBACK optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

公式の関連項目
使用する型