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

ExitWindowsEx

関数
Windowsのログオフや再起動、シャットダウンを実行する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL ExitWindowsEx(
    EXIT_WINDOWS_FLAGS uFlags,
    SHUTDOWN_REASON dwReason
);

パラメーター

名前型方向説明
uFlagsEXIT_WINDOWS_FLAGSin

シャットダウンの種類。このパラメーターには、次のいずれかの値を含める必要があります。

値 意味
EWX_HYBRID_SHUTDOWN
0x00400000
Windows 8 以降: EWX_HYBRID_SHUTDOWN フラグを EWX_SHUTDOWN フラグと組み合わせることで、次回の起動が高速になるようにシステムを準備できます。
EWX_LOGOFF
0
ExitWindowsEx 関数を呼び出したプロセスのログオンセッションで実行されているすべてのプロセスをシャットダウンします。その後、ユーザーをログオフします。

このフラグは、対話ユーザーのログオンセッションで実行されているプロセスからのみ使用できます。

EWX_POWEROFF
0x00000008
システムをシャットダウンし、電源をオフにします。システムが電源オフ機能をサポートしている必要があります。

呼び出し元のプロセスは SE_SHUTDOWN_NAME 特権を持っている必要があります。詳細については、後述の「解説」セクションを参照してください。

EWX_REBOOT
0x00000002
システムをシャットダウンし、その後システムを再起動します。

呼び出し元のプロセスは SE_SHUTDOWN_NAME 特権を持っている必要があります。詳細については、後述の「解説」セクションを参照してください。

EWX_RESTARTAPPS
0x00000040
システムをシャットダウンして再起動し、あわせて RegisterApplicationRestart 関数を使用して再起動用に登録されているアプリケーションも再起動します。これらのアプリケーションは、lParam に ENDSESSION_CLOSEAPP 値が設定された WM_QUERYENDSESSION メッセージを受け取ります。詳細については、アプリケーションのガイドラインを参照してください。
EWX_SHUTDOWN
0x00000001
電源を切っても安全な状態になるところまでシステムをシャットダウンします。すべてのファイルバッファーはディスクにフラッシュされ、実行中のすべてのプロセスは停止しています。

呼び出し元のプロセスは SE_SHUTDOWN_NAME 特権を持っている必要があります。詳細については、後述の「解説」セクションを参照してください。

このフラグを指定しても、システムが電源オフ機能をサポートしている場合でも電源はオフになりません。電源をオフにするには EWX_POWEROFF を指定する必要があります。Windows XP SP1: システムが電源オフ機能をサポートしている場合、このフラグを指定すると電源がオフになります。

このパラメーターには、必要に応じて次のいずれかの値を含めることができます。

値 意味
EWX_FORCE
0x00000004
ターミナルサービスが有効になっている場合、このフラグは効果がありません。それ以外の場合、システムは WM_QUERYENDSESSION メッセージを送信しません。これにより、アプリケーションがデータを失うことがあります。そのため、このフラグは緊急時にのみ使用してください。
EWX_FORCEIFHUNG
0x00000010
プロセスがタイムアウト間隔内に WM_QUERYENDSESSION メッセージまたは WM_ENDSESSION メッセージに応答しない場合、そのプロセスを強制的に終了させます。詳細については「解説」を参照してください。
dwReasonSHUTDOWN_REASONin

シャットダウンを開始する理由。このパラメーターは、 システムシャットダウン理由コードのいずれかである必要があります。

このパラメーターが 0 の場合、SHTDN_REASON_FLAG_PLANNED 理由コードは設定されないため、既定の動作は「No title for this reason could be found」として記録される未定義のシャットダウンになります。既定では、計画外のシャットダウンにもなります。システムの構成によっては、計画外のシャットダウンによってシステムの状態情報を含むファイルの作成が行われ、シャットダウンが遅延することがあります。したがって、このパラメーターに 0 を使用しないでください。

戻り値の型: BOOL

公式ドキュメント

対話ユーザーをログオフする、システムをシャットダウンする、またはシステムをシャットダウンして再起動します。

戻り値

関数が成功すると、戻り値は 0 以外になります。この関数は非同期に実行されるため、0 以外の戻り値はシャットダウンが開始されたことを示します。シャットダウンが成功するかどうかを示すものではありません。システム、ユーザー、または別のアプリケーションがシャットダウンを中止する可能性があります。

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

解説(Remarks)

ExitWindowsEx 関数は、シャットダウン処理を開始するとすぐに戻ります。その後、シャットダウンまたはログオフは非同期に進行します。この関数は、呼び出し元のログオンセッション内のすべてのプロセスを停止するように設計されています。そのため、呼び出し元が対話ユーザーでない場合は、実際にコンピューターがシャットダウンされなくても関数が成功することがあります。対話ユーザーでない場合は、 InitiateSystemShutdown 関数または InitiateSystemShutdownEx 関数を使用してください。

戻り値が 0 以外であっても、ログオフが成功した、または成功することを意味するわけではありません。シャットダウンは非同期の処理であり、API 呼び出しが戻ってからかなり後に発生することも、まったく発生しないこともあります。タイムアウト値が 0 であっても、アプリケーション、サービス、あるいはシステム自体によってシャットダウンが中止される場合があります。0 以外の戻り値は、権限とパラメーターの検証が成功し、システムがシャットダウン要求を受け付けたことを示します。

この関数を呼び出すとき、呼び出し元は、保存されていない変更があるアプリケーションを強制的に閉じるかどうかを指定する必要があります。呼び出し元がこれらのアプリケーションを強制的に閉じないことを選択し、保存されていない変更があるアプリケーションがコンソールセッションで実行されている場合、コンソールセッションにログオンしているユーザーがシャットダウンを中止するか、変更を保存するか、アプリケーションを閉じるか、アプリケーションを強制的に閉じるまで、シャットダウンは進行中のままになります。この間、シャットダウンはコンソールユーザー以外は中止できず、別のシャットダウンを開始することもできません。

uFlags パラメーターの値に EWX_FORCE を設定してこの関数を呼び出すと、この状況を回避できます。ただし、その場合はデータが失われる可能性があることに注意してください。

システム内の他のアプリケーションに対する相対的なシャットダウン優先度をアプリケーションに設定するには、 SetProcessShutdownParameters 関数を使用します。

シャットダウンまたはログオフの操作中、実行中のアプリケーションにはシャットダウン要求に応答するための一定の時間が与えられます。すべてのアプリケーションが停止する前にこの時間が経過すると、システムはユーザーインターフェイスを表示し、ユーザーがシステムを強制的にシャットダウンするか、シャットダウン要求を取り消すかを選択できるようにします。EWX_FORCE 値が指定されている場合、システムは時間が経過した時点で実行中のアプリケーションを強制的に停止します。

EWX_FORCEIFHUNG 値が指定されている場合、システムは応答しなくなったアプリケーションを強制的に閉じ、ダイアログボックスを表示しません。

コンソールプロセスは、状況に応じて CTRL_SHUTDOWN_EVENT または CTRL_LOGOFF_EVENT という別個の通知メッセージを受け取ります。コンソールプロセスは、これらのメッセージを自身の HandlerRoutine 関数に振り分けます。 ExitWindowsEx はこれらの通知メッセージを非同期に送信します。そのため、 ExitWindowsEx の呼び出しが戻った時点でコンソール通知メッセージが処理済みであるとアプリケーションが想定することはできません。

システムをシャットダウンまたは再起動するには、呼び出し元のプロセスは AdjustTokenPrivileges 関数を使用して SE_SHUTDOWN_NAME 特権を有効にする必要があります。詳細については、 特別な特権での実行を参照してください。

例

例については、 システムをシャットダウンする方法を参照してください。

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

各言語での呼び出し定義

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

BOOL ExitWindowsEx(
    EXIT_WINDOWS_FLAGS uFlags,
    SHUTDOWN_REASON dwReason
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ExitWindowsEx(
    uint uFlags,   // EXIT_WINDOWS_FLAGS
    uint dwReason   // SHUTDOWN_REASON
);
<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ExitWindowsEx(
    uFlags As UInteger,   ' EXIT_WINDOWS_FLAGS
    dwReason As UInteger   ' SHUTDOWN_REASON
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' uFlags : EXIT_WINDOWS_FLAGS
' dwReason : SHUTDOWN_REASON
Declare PtrSafe Function ExitWindowsEx Lib "user32" ( _
    ByVal uFlags As Long, _
    ByVal dwReason As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ExitWindowsEx = ctypes.windll.user32.ExitWindowsEx
ExitWindowsEx.restype = wintypes.BOOL
ExitWindowsEx.argtypes = [
    wintypes.DWORD,  # uFlags : EXIT_WINDOWS_FLAGS
    wintypes.DWORD,  # dwReason : SHUTDOWN_REASON
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
ExitWindowsEx = Fiddle::Function.new(
  lib['ExitWindowsEx'],
  [
    -Fiddle::TYPE_INT,  # uFlags : EXIT_WINDOWS_FLAGS
    -Fiddle::TYPE_INT,  # dwReason : SHUTDOWN_REASON
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn ExitWindowsEx(
        uFlags: u32,  // EXIT_WINDOWS_FLAGS
        dwReason: u32  // SHUTDOWN_REASON
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true)]
public static extern bool ExitWindowsEx(uint uFlags, uint dwReason);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_ExitWindowsEx' -Namespace Win32 -PassThru
# $api::ExitWindowsEx(uFlags, dwReason)
#uselib "USER32.dll"
#func global ExitWindowsEx "ExitWindowsEx" sptr, sptr
; ExitWindowsEx uFlags, dwReason   ; 戻り値は stat
; uFlags : EXIT_WINDOWS_FLAGS -> "sptr"
; dwReason : SHUTDOWN_REASON -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global ExitWindowsEx "ExitWindowsEx" int, int
; res = ExitWindowsEx(uFlags, dwReason)
; uFlags : EXIT_WINDOWS_FLAGS -> "int"
; dwReason : SHUTDOWN_REASON -> "int"
; BOOL ExitWindowsEx(EXIT_WINDOWS_FLAGS uFlags, SHUTDOWN_REASON dwReason)
#uselib "USER32.dll"
#cfunc global ExitWindowsEx "ExitWindowsEx" int, int
; res = ExitWindowsEx(uFlags, dwReason)
; uFlags : EXIT_WINDOWS_FLAGS -> "int"
; dwReason : SHUTDOWN_REASON -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procExitWindowsEx = user32.NewProc("ExitWindowsEx")
)

// uFlags (EXIT_WINDOWS_FLAGS), dwReason (SHUTDOWN_REASON)
r1, _, err := procExitWindowsEx.Call(
	uintptr(uFlags),
	uintptr(dwReason),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function ExitWindowsEx(
  uFlags: DWORD;   // EXIT_WINDOWS_FLAGS
  dwReason: DWORD   // SHUTDOWN_REASON
): BOOL; stdcall;
  external 'USER32.dll' name 'ExitWindowsEx';
result := DllCall("USER32\ExitWindowsEx"
    , "UInt", uFlags   ; EXIT_WINDOWS_FLAGS
    , "UInt", dwReason   ; SHUTDOWN_REASON
    , "Int")   ; return: BOOL
●ExitWindowsEx(uFlags, dwReason) = DLL("USER32.dll", "bool ExitWindowsEx(dword, dword)")
# 呼び出し: ExitWindowsEx(uFlags, dwReason)
# uFlags : EXIT_WINDOWS_FLAGS -> "dword"
# dwReason : SHUTDOWN_REASON -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef ExitWindowsExNative = Int32 Function(Uint32, Uint32);
typedef ExitWindowsExDart = int Function(int, int);
final ExitWindowsEx = DynamicLibrary.open('USER32.dll')
    .lookupFunction<ExitWindowsExNative, ExitWindowsExDart>('ExitWindowsEx');
// uFlags : EXIT_WINDOWS_FLAGS -> Uint32
// dwReason : SHUTDOWN_REASON -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ExitWindowsEx(
  uFlags: DWORD;   // EXIT_WINDOWS_FLAGS
  dwReason: DWORD   // SHUTDOWN_REASON
): BOOL; stdcall;
  external 'USER32.dll' name 'ExitWindowsEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ExitWindowsEx"
  c_ExitWindowsEx :: Word32 -> Word32 -> IO CInt
-- uFlags : EXIT_WINDOWS_FLAGS -> Word32
-- dwReason : SHUTDOWN_REASON -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let exitwindowsex =
  foreign "ExitWindowsEx"
    (uint32_t @-> uint32_t @-> returning int32_t)
(* uFlags : EXIT_WINDOWS_FLAGS -> uint32_t *)
(* dwReason : SHUTDOWN_REASON -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("ExitWindowsEx" exit-windows-ex :convention :stdcall) :int32
  (u-flags :uint32)   ; EXIT_WINDOWS_FLAGS
  (dw-reason :uint32))   ; SHUTDOWN_REASON
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ExitWindowsEx = Win32::API::More->new('USER32',
    'BOOL ExitWindowsEx(DWORD uFlags, DWORD dwReason)');
# my $ret = $ExitWindowsEx->Call($uFlags, $dwReason);
# uFlags : EXIT_WINDOWS_FLAGS -> DWORD
# dwReason : SHUTDOWN_REASON -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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