RestartDialogEx

関数

理由コード付きで再起動を促すダイアログを表示する。

DLLSHELL32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT RestartDialogEx(
    HWND hwnd,   // optional
    LPCWSTR pszPrompt,   // optional
    DWORD dwReturn,
    DWORD dwReasonCode
);

パラメーター

名前	型	方向	説明
hwnd	HWND	inoptional	親ウィンドウへのハンドル。
pszPrompt	LPCWSTR	inoptional	ユーザーへの入力を促すためにダイアログボックスに表示されるテキストを含む、null 終端文字列。
dwReturn	DWORD	in	シャットダウンの種類を指定するフラグ。このパラメーターには、次の値のいずれかを含める必要があります。 EWX_LOGOFF この関数を呼び出したプロセスのセキュリティコンテキストで実行されているすべてのプロセスをシャットダウンします。その後、ユーザーをログオフします。 EWX_POWEROFF システムをシャットダウンし、電源を切ります。システムが電源オフ機能をサポートしている必要があります。呼び出し元のプロセスには SE_SHUTDOWN_NAME 特権が必要です。詳細については、ExitWindowsEx を参照してください。 EWX_REBOOT システムをシャットダウンし、その後システムを再起動します。呼び出し元のプロセスには SE_SHUTDOWN_NAME 特権が必要です。詳細については、ExitWindowsEx を参照してください。 EWX_SHUTDOWN 電源を安全に切れる状態までシステムをシャットダウンします。この時点で、すべてのファイルバッファーがディスクにフラッシュされ、実行中のすべてのプロセスが停止しています。システムが電源オフ機能をサポートしている場合は、電源も切られます。呼び出し元のプロセスには SE_SHUTDOWN_NAME 特権が必要です。詳細については、ExitWindowsEx を参照してください。このパラメーターには、オプションで次の値を含めることができます。 EWX_FORCE プロセスを強制的に終了させます。このフラグが設定されている場合、システムは WM_QUERYENDSESSION および WM_ENDSESSION メッセージを送信しません。これによりアプリケーションがデータを失う可能性があります。したがって、このフラグは緊急時にのみ使用してください。 EWX_FORCEIFHUNG プロセスが WM_QUERYENDSESSION または WM_ENDSESSION メッセージに応答しない場合に、プロセスを強制的に終了させます。EWX_FORCE が使用されている場合、このフラグは無視されます。
dwReasonCode	DWORD	in	Windows XP: シャットダウンを開始する理由を指定します。詳細については、System Shutdown Reason Codes を参照してください。 Windows 2000: このパラメーターは無視されます。

戻り値の型: INT

公式ドキュメント

Windows の再起動をユーザーに求めるダイアログボックスを表示します。ユーザーがボタンをクリックすると、この関数は ExitWindowsEx を呼び出して Windows の再起動を試みます。

戻り値

型: int

ダイアログボックスを閉じるために押されたボタンの識別子を返します。

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

各言語での呼び出し定義

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

INT RestartDialogEx(
    HWND hwnd,   // optional
    LPCWSTR pszPrompt,   // optional
    DWORD dwReturn,
    DWORD dwReasonCode
);

[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int RestartDialogEx(
    IntPtr hwnd,   // HWND optional
    [MarshalAs(UnmanagedType.LPWStr)] string pszPrompt,   // LPCWSTR optional
    uint dwReturn,   // DWORD
    uint dwReasonCode   // DWORD
);

<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function RestartDialogEx(
    hwnd As IntPtr,   ' HWND optional
    <MarshalAs(UnmanagedType.LPWStr)> pszPrompt As String,   ' LPCWSTR optional
    dwReturn As UInteger,   ' DWORD
    dwReasonCode As UInteger   ' DWORD
) As Integer
End Function

' hwnd : HWND optional
' pszPrompt : LPCWSTR optional
' dwReturn : DWORD
' dwReasonCode : DWORD
Declare PtrSafe Function RestartDialogEx Lib "shell32" ( _
    ByVal hwnd As LongPtr, _
    ByVal pszPrompt As LongPtr, _
    ByVal dwReturn As Long, _
    ByVal dwReasonCode As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RestartDialogEx = ctypes.windll.shell32.RestartDialogEx
RestartDialogEx.restype = ctypes.c_int
RestartDialogEx.argtypes = [
    wintypes.HANDLE,  # hwnd : HWND optional
    wintypes.LPCWSTR,  # pszPrompt : LPCWSTR optional
    wintypes.DWORD,  # dwReturn : DWORD
    wintypes.DWORD,  # dwReasonCode : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
RestartDialogEx = Fiddle::Function.new(
  lib['RestartDialogEx'],
  [
    Fiddle::TYPE_VOIDP,  # hwnd : HWND optional
    Fiddle::TYPE_VOIDP,  # pszPrompt : LPCWSTR optional
    -Fiddle::TYPE_INT,  # dwReturn : DWORD
    -Fiddle::TYPE_INT,  # dwReasonCode : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn RestartDialogEx(
        hwnd: *mut core::ffi::c_void,  // HWND optional
        pszPrompt: *const u16,  // LPCWSTR optional
        dwReturn: u32,  // DWORD
        dwReasonCode: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHELL32.dll")]
public static extern int RestartDialogEx(IntPtr hwnd, [MarshalAs(UnmanagedType.LPWStr)] string pszPrompt, uint dwReturn, uint dwReasonCode);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_RestartDialogEx' -Namespace Win32 -PassThru
# $api::RestartDialogEx(hwnd, pszPrompt, dwReturn, dwReasonCode)

#uselib "SHELL32.dll"
#func global RestartDialogEx "RestartDialogEx" sptr, sptr, sptr, sptr
; RestartDialogEx hwnd, pszPrompt, dwReturn, dwReasonCode   ; 戻り値は stat
; hwnd : HWND optional -> "sptr"
; pszPrompt : LPCWSTR optional -> "sptr"
; dwReturn : DWORD -> "sptr"
; dwReasonCode : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "SHELL32.dll"
#cfunc global RestartDialogEx "RestartDialogEx" sptr, wstr, int, int
; res = RestartDialogEx(hwnd, pszPrompt, dwReturn, dwReasonCode)
; hwnd : HWND optional -> "sptr"
; pszPrompt : LPCWSTR optional -> "wstr"
; dwReturn : DWORD -> "int"
; dwReasonCode : DWORD -> "int"

; INT RestartDialogEx(HWND hwnd, LPCWSTR pszPrompt, DWORD dwReturn, DWORD dwReasonCode)
#uselib "SHELL32.dll"
#cfunc global RestartDialogEx "RestartDialogEx" intptr, wstr, int, int
; res = RestartDialogEx(hwnd, pszPrompt, dwReturn, dwReasonCode)
; hwnd : HWND optional -> "intptr"
; pszPrompt : LPCWSTR optional -> "wstr"
; dwReturn : DWORD -> "int"
; dwReasonCode : DWORD -> "int"

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procRestartDialogEx = shell32.NewProc("RestartDialogEx")
)

// hwnd (HWND optional), pszPrompt (LPCWSTR optional), dwReturn (DWORD), dwReasonCode (DWORD)
r1, _, err := procRestartDialogEx.Call(
	uintptr(hwnd),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszPrompt))),
	uintptr(dwReturn),
	uintptr(dwReasonCode),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT

function RestartDialogEx(
  hwnd: THandle;   // HWND optional
  pszPrompt: PWideChar;   // LPCWSTR optional
  dwReturn: DWORD;   // DWORD
  dwReasonCode: DWORD   // DWORD
): Integer; stdcall;
  external 'SHELL32.dll' name 'RestartDialogEx';

result := DllCall("SHELL32\RestartDialogEx"
    , "Ptr", hwnd   ; HWND optional
    , "WStr", pszPrompt   ; LPCWSTR optional
    , "UInt", dwReturn   ; DWORD
    , "UInt", dwReasonCode   ; DWORD
    , "Int")   ; return: INT

●RestartDialogEx(hwnd, pszPrompt, dwReturn, dwReasonCode) = DLL("SHELL32.dll", "int RestartDialogEx(void*, char*, dword, dword)")
# 呼び出し: RestartDialogEx(hwnd, pszPrompt, dwReturn, dwReasonCode)
# hwnd : HWND optional -> "void*"
# pszPrompt : LPCWSTR optional -> "char*"
# dwReturn : DWORD -> "dword"
# dwReasonCode : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "shell32" fn RestartDialogEx(
    hwnd: ?*anyopaque, // HWND optional
    pszPrompt: [*c]const u16, // LPCWSTR optional
    dwReturn: u32, // DWORD
    dwReasonCode: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;

proc RestartDialogEx(
    hwnd: pointer,  # HWND optional
    pszPrompt: WideCString,  # LPCWSTR optional
    dwReturn: uint32,  # DWORD
    dwReasonCode: uint32  # DWORD
): int32 {.importc: "RestartDialogEx", stdcall, dynlib: "SHELL32.dll".}

pragma(lib, "shell32");
extern(Windows)
int RestartDialogEx(
    void* hwnd,   // HWND optional
    const(wchar)* pszPrompt,   // LPCWSTR optional
    uint dwReturn,   // DWORD
    uint dwReasonCode   // DWORD
);

ccall((:RestartDialogEx, "SHELL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cwstring, UInt32, UInt32),
      hwnd, pszPrompt, dwReturn, dwReasonCode)
# hwnd : HWND optional -> Ptr{Cvoid}
# pszPrompt : LPCWSTR optional -> Cwstring
# dwReturn : DWORD -> UInt32
# dwReasonCode : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t RestartDialogEx(
    void* hwnd,
    const uint16_t* pszPrompt,
    uint32_t dwReturn,
    uint32_t dwReasonCode);
]]
local shell32 = ffi.load("shell32")
-- shell32.RestartDialogEx(hwnd, pszPrompt, dwReturn, dwReasonCode)
-- hwnd : HWND optional
-- pszPrompt : LPCWSTR optional
-- dwReturn : DWORD
-- dwReasonCode : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const RestartDialogEx = lib.func('__stdcall', 'RestartDialogEx', 'int32_t', ['void *', 'str16', 'uint32_t', 'uint32_t']);
// RestartDialogEx(hwnd, pszPrompt, dwReturn, dwReasonCode)
// hwnd : HWND optional -> 'void *'
// pszPrompt : LPCWSTR optional -> 'str16'
// dwReturn : DWORD -> 'uint32_t'
// dwReasonCode : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("SHELL32.dll", {
  RestartDialogEx: { parameters: ["pointer", "buffer", "u32", "u32"], result: "i32" },
});
// lib.symbols.RestartDialogEx(hwnd, pszPrompt, dwReturn, dwReasonCode)
// hwnd : HWND optional -> "pointer"
// pszPrompt : LPCWSTR optional -> "buffer"
// dwReturn : DWORD -> "u32"
// dwReasonCode : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t RestartDialogEx(
    void* hwnd,
    const uint16_t* pszPrompt,
    uint32_t dwReturn,
    uint32_t dwReasonCode);
C, "SHELL32.dll");
// $ffi->RestartDialogEx(hwnd, pszPrompt, dwReturn, dwReasonCode);
// hwnd : HWND optional
// pszPrompt : LPCWSTR optional
// dwReturn : DWORD
// dwReasonCode : DWORD
// 構造体/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 Shell32 extends StdCallLibrary {
    Shell32 INSTANCE = Native.load("shell32", Shell32.class);
    int RestartDialogEx(
        Pointer hwnd,   // HWND optional
        WString pszPrompt,   // LPCWSTR optional
        int dwReturn,   // DWORD
        int dwReasonCode   // DWORD
    );
}

@[Link("shell32")]
lib LibSHELL32
  fun RestartDialogEx = RestartDialogEx(
    hwnd : Void*,   # HWND optional
    pszPrompt : UInt16*,   # LPCWSTR optional
    dwReturn : UInt32,   # DWORD
    dwReasonCode : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef RestartDialogExNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Uint32, Uint32);
typedef RestartDialogExDart = int Function(Pointer<Void>, Pointer<Utf16>, int, int);
final RestartDialogEx = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<RestartDialogExNative, RestartDialogExDart>('RestartDialogEx');
// hwnd : HWND optional -> Pointer<Void>
// pszPrompt : LPCWSTR optional -> Pointer<Utf16>
// dwReturn : DWORD -> Uint32
// dwReasonCode : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function RestartDialogEx(
  hwnd: THandle;   // HWND optional
  pszPrompt: PWideChar;   // LPCWSTR optional
  dwReturn: DWORD;   // DWORD
  dwReasonCode: DWORD   // DWORD
): Integer; stdcall;
  external 'SHELL32.dll' name 'RestartDialogEx';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RestartDialogEx"
  c_RestartDialogEx :: Ptr () -> CWString -> Word32 -> Word32 -> IO Int32
-- hwnd : HWND optional -> Ptr ()
-- pszPrompt : LPCWSTR optional -> CWString
-- dwReturn : DWORD -> Word32
-- dwReasonCode : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let restartdialogex =
  foreign "RestartDialogEx"
    ((ptr void) @-> (ptr uint16_t) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* hwnd : HWND optional -> (ptr void) *)
(* pszPrompt : LPCWSTR optional -> (ptr uint16_t) *)
(* dwReturn : DWORD -> uint32_t *)
(* dwReasonCode : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("RestartDialogEx" restart-dialog-ex :convention :stdcall) :int32
  (hwnd :pointer)   ; HWND optional
  (psz-prompt (:string :encoding :utf-16le))   ; LPCWSTR optional
  (dw-return :uint32)   ; DWORD
  (dw-reason-code :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $RestartDialogEx = Win32::API::More->new('SHELL32',
    'int RestartDialogEx(HANDLE hwnd, LPCWSTR pszPrompt, DWORD dwReturn, DWORD dwReasonCode)');
# my $ret = $RestartDialogEx->Call($hwnd, $pszPrompt, $dwReturn, $dwReasonCode);
# hwnd : HWND optional -> HANDLE
# pszPrompt : LPCWSTR optional -> LPCWSTR
# dwReturn : DWORD -> DWORD
# dwReasonCode : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

RestartDialogEx

シグネチャ

パラメーター

EWX_LOGOFF

EWX_POWEROFF

EWX_REBOOT

EWX_SHUTDOWN

EWX_FORCE

EWX_FORCEIFHUNG

公式ドキュメント

戻り値

各言語での呼び出し定義

関連項目