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

InitiateSystemShutdownExA

関数
理由コード付きでシステムシャットダウンを開始する。
DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL InitiateSystemShutdownExA(
    LPSTR lpMachineName,   // optional
    LPSTR lpMessage,   // optional
    DWORD dwTimeout,
    BOOL bForceAppsClosed,
    BOOL bRebootAfterShutdown,
    SHUTDOWN_REASON dwReason
);

パラメーター

名前型方向説明
lpMachineNameLPSTRinoptionalシャットダウン対象のコンピュータ名。NULLでローカルマシン。
lpMessageLPSTRinoptionalユーザーに表示する警告メッセージ。NULL可。
dwTimeoutDWORDinシャットダウン開始までの猶予時間(秒)。
bForceAppsClosedBOOLinTRUEで未保存アプリを強制終了する。
bRebootAfterShutdownBOOLinTRUEでシャットダウン後に再起動する。
dwReasonSHUTDOWN_REASONinシャットダウン理由コード。SHTDN_REASON_*の組み合わせ。

戻り値の型: BOOL

各言語での呼び出し定義

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL InitiateSystemShutdownExA(
    LPSTR lpMachineName,   // optional
    LPSTR lpMessage,   // optional
    DWORD dwTimeout,
    BOOL bForceAppsClosed,
    BOOL bRebootAfterShutdown,
    SHUTDOWN_REASON dwReason
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool InitiateSystemShutdownExA(
    [MarshalAs(UnmanagedType.LPStr)] string lpMachineName,   // LPSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string lpMessage,   // LPSTR optional
    uint dwTimeout,   // DWORD
    bool bForceAppsClosed,   // BOOL
    bool bRebootAfterShutdown,   // BOOL
    uint dwReason   // SHUTDOWN_REASON
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InitiateSystemShutdownExA(
    <MarshalAs(UnmanagedType.LPStr)> lpMachineName As String,   ' LPSTR optional
    <MarshalAs(UnmanagedType.LPStr)> lpMessage As String,   ' LPSTR optional
    dwTimeout As UInteger,   ' DWORD
    bForceAppsClosed As Boolean,   ' BOOL
    bRebootAfterShutdown As Boolean,   ' BOOL
    dwReason As UInteger   ' SHUTDOWN_REASON
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpMachineName : LPSTR optional
' lpMessage : LPSTR optional
' dwTimeout : DWORD
' bForceAppsClosed : BOOL
' bRebootAfterShutdown : BOOL
' dwReason : SHUTDOWN_REASON
Declare PtrSafe Function InitiateSystemShutdownExA Lib "advapi32" ( _
    ByVal lpMachineName As String, _
    ByVal lpMessage As String, _
    ByVal dwTimeout As Long, _
    ByVal bForceAppsClosed As Long, _
    ByVal bRebootAfterShutdown 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

InitiateSystemShutdownExA = ctypes.windll.advapi32.InitiateSystemShutdownExA
InitiateSystemShutdownExA.restype = wintypes.BOOL
InitiateSystemShutdownExA.argtypes = [
    wintypes.LPCSTR,  # lpMachineName : LPSTR optional
    wintypes.LPCSTR,  # lpMessage : LPSTR optional
    wintypes.DWORD,  # dwTimeout : DWORD
    wintypes.BOOL,  # bForceAppsClosed : BOOL
    wintypes.BOOL,  # bRebootAfterShutdown : BOOL
    wintypes.DWORD,  # dwReason : SHUTDOWN_REASON
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
InitiateSystemShutdownExA = Fiddle::Function.new(
  lib['InitiateSystemShutdownExA'],
  [
    Fiddle::TYPE_VOIDP,  # lpMachineName : LPSTR optional
    Fiddle::TYPE_VOIDP,  # lpMessage : LPSTR optional
    -Fiddle::TYPE_INT,  # dwTimeout : DWORD
    Fiddle::TYPE_INT,  # bForceAppsClosed : BOOL
    Fiddle::TYPE_INT,  # bRebootAfterShutdown : BOOL
    -Fiddle::TYPE_INT,  # dwReason : SHUTDOWN_REASON
  ],
  Fiddle::TYPE_INT)
#[link(name = "advapi32")]
extern "system" {
    fn InitiateSystemShutdownExA(
        lpMachineName: *mut u8,  // LPSTR optional
        lpMessage: *mut u8,  // LPSTR optional
        dwTimeout: u32,  // DWORD
        bForceAppsClosed: i32,  // BOOL
        bRebootAfterShutdown: i32,  // BOOL
        dwReason: u32  // SHUTDOWN_REASON
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool InitiateSystemShutdownExA([MarshalAs(UnmanagedType.LPStr)] string lpMachineName, [MarshalAs(UnmanagedType.LPStr)] string lpMessage, uint dwTimeout, bool bForceAppsClosed, bool bRebootAfterShutdown, uint dwReason);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_InitiateSystemShutdownExA' -Namespace Win32 -PassThru
# $api::InitiateSystemShutdownExA(lpMachineName, lpMessage, dwTimeout, bForceAppsClosed, bRebootAfterShutdown, dwReason)
#uselib "ADVAPI32.dll"
#func global InitiateSystemShutdownExA "InitiateSystemShutdownExA" sptr, sptr, sptr, sptr, sptr, sptr
; InitiateSystemShutdownExA lpMachineName, lpMessage, dwTimeout, bForceAppsClosed, bRebootAfterShutdown, dwReason   ; 戻り値は stat
; lpMachineName : LPSTR optional -> "sptr"
; lpMessage : LPSTR optional -> "sptr"
; dwTimeout : DWORD -> "sptr"
; bForceAppsClosed : BOOL -> "sptr"
; bRebootAfterShutdown : BOOL -> "sptr"
; dwReason : SHUTDOWN_REASON -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ADVAPI32.dll"
#cfunc global InitiateSystemShutdownExA "InitiateSystemShutdownExA" str, str, int, int, int, int
; res = InitiateSystemShutdownExA(lpMachineName, lpMessage, dwTimeout, bForceAppsClosed, bRebootAfterShutdown, dwReason)
; lpMachineName : LPSTR optional -> "str"
; lpMessage : LPSTR optional -> "str"
; dwTimeout : DWORD -> "int"
; bForceAppsClosed : BOOL -> "int"
; bRebootAfterShutdown : BOOL -> "int"
; dwReason : SHUTDOWN_REASON -> "int"
; BOOL InitiateSystemShutdownExA(LPSTR lpMachineName, LPSTR lpMessage, DWORD dwTimeout, BOOL bForceAppsClosed, BOOL bRebootAfterShutdown, SHUTDOWN_REASON dwReason)
#uselib "ADVAPI32.dll"
#cfunc global InitiateSystemShutdownExA "InitiateSystemShutdownExA" str, str, int, int, int, int
; res = InitiateSystemShutdownExA(lpMachineName, lpMessage, dwTimeout, bForceAppsClosed, bRebootAfterShutdown, dwReason)
; lpMachineName : LPSTR optional -> "str"
; lpMessage : LPSTR optional -> "str"
; dwTimeout : DWORD -> "int"
; bForceAppsClosed : BOOL -> "int"
; bRebootAfterShutdown : BOOL -> "int"
; dwReason : SHUTDOWN_REASON -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procInitiateSystemShutdownExA = advapi32.NewProc("InitiateSystemShutdownExA")
)

// lpMachineName (LPSTR optional), lpMessage (LPSTR optional), dwTimeout (DWORD), bForceAppsClosed (BOOL), bRebootAfterShutdown (BOOL), dwReason (SHUTDOWN_REASON)
r1, _, err := procInitiateSystemShutdownExA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpMachineName))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpMessage))),
	uintptr(dwTimeout),
	uintptr(bForceAppsClosed),
	uintptr(bRebootAfterShutdown),
	uintptr(dwReason),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function InitiateSystemShutdownExA(
  lpMachineName: PAnsiChar;   // LPSTR optional
  lpMessage: PAnsiChar;   // LPSTR optional
  dwTimeout: DWORD;   // DWORD
  bForceAppsClosed: BOOL;   // BOOL
  bRebootAfterShutdown: BOOL;   // BOOL
  dwReason: DWORD   // SHUTDOWN_REASON
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'InitiateSystemShutdownExA';
result := DllCall("ADVAPI32\InitiateSystemShutdownExA"
    , "AStr", lpMachineName   ; LPSTR optional
    , "AStr", lpMessage   ; LPSTR optional
    , "UInt", dwTimeout   ; DWORD
    , "Int", bForceAppsClosed   ; BOOL
    , "Int", bRebootAfterShutdown   ; BOOL
    , "UInt", dwReason   ; SHUTDOWN_REASON
    , "Int")   ; return: BOOL
●InitiateSystemShutdownExA(lpMachineName, lpMessage, dwTimeout, bForceAppsClosed, bRebootAfterShutdown, dwReason) = DLL("ADVAPI32.dll", "bool InitiateSystemShutdownExA(char*, char*, dword, bool, bool, dword)")
# 呼び出し: InitiateSystemShutdownExA(lpMachineName, lpMessage, dwTimeout, bForceAppsClosed, bRebootAfterShutdown, dwReason)
# lpMachineName : LPSTR optional -> "char*"
# lpMessage : LPSTR optional -> "char*"
# dwTimeout : DWORD -> "dword"
# bForceAppsClosed : BOOL -> "bool"
# bRebootAfterShutdown : BOOL -> "bool"
# dwReason : SHUTDOWN_REASON -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "advapi32" fn InitiateSystemShutdownExA(
    lpMachineName: [*c]const u8, // LPSTR optional
    lpMessage: [*c]const u8, // LPSTR optional
    dwTimeout: u32, // DWORD
    bForceAppsClosed: i32, // BOOL
    bRebootAfterShutdown: i32, // BOOL
    dwReason: u32 // SHUTDOWN_REASON
) callconv(std.os.windows.WINAPI) i32;
proc InitiateSystemShutdownExA(
    lpMachineName: cstring,  # LPSTR optional
    lpMessage: cstring,  # LPSTR optional
    dwTimeout: uint32,  # DWORD
    bForceAppsClosed: int32,  # BOOL
    bRebootAfterShutdown: int32,  # BOOL
    dwReason: uint32  # SHUTDOWN_REASON
): int32 {.importc: "InitiateSystemShutdownExA", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
int InitiateSystemShutdownExA(
    const(char)* lpMachineName,   // LPSTR optional
    const(char)* lpMessage,   // LPSTR optional
    uint dwTimeout,   // DWORD
    int bForceAppsClosed,   // BOOL
    int bRebootAfterShutdown,   // BOOL
    uint dwReason   // SHUTDOWN_REASON
);
ccall((:InitiateSystemShutdownExA, "ADVAPI32.dll"), stdcall, Int32,
      (Cstring, Cstring, UInt32, Int32, Int32, UInt32),
      lpMachineName, lpMessage, dwTimeout, bForceAppsClosed, bRebootAfterShutdown, dwReason)
# lpMachineName : LPSTR optional -> Cstring
# lpMessage : LPSTR optional -> Cstring
# dwTimeout : DWORD -> UInt32
# bForceAppsClosed : BOOL -> Int32
# bRebootAfterShutdown : BOOL -> Int32
# dwReason : SHUTDOWN_REASON -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t InitiateSystemShutdownExA(
    const char* lpMachineName,
    const char* lpMessage,
    uint32_t dwTimeout,
    int32_t bForceAppsClosed,
    int32_t bRebootAfterShutdown,
    uint32_t dwReason);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.InitiateSystemShutdownExA(lpMachineName, lpMessage, dwTimeout, bForceAppsClosed, bRebootAfterShutdown, dwReason)
-- lpMachineName : LPSTR optional
-- lpMessage : LPSTR optional
-- dwTimeout : DWORD
-- bForceAppsClosed : BOOL
-- bRebootAfterShutdown : BOOL
-- dwReason : SHUTDOWN_REASON
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const InitiateSystemShutdownExA = lib.func('__stdcall', 'InitiateSystemShutdownExA', 'int32_t', ['str', 'str', 'uint32_t', 'int32_t', 'int32_t', 'uint32_t']);
// InitiateSystemShutdownExA(lpMachineName, lpMessage, dwTimeout, bForceAppsClosed, bRebootAfterShutdown, dwReason)
// lpMachineName : LPSTR optional -> 'str'
// lpMessage : LPSTR optional -> 'str'
// dwTimeout : DWORD -> 'uint32_t'
// bForceAppsClosed : BOOL -> 'int32_t'
// bRebootAfterShutdown : BOOL -> 'int32_t'
// dwReason : SHUTDOWN_REASON -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  InitiateSystemShutdownExA: { parameters: ["buffer", "buffer", "u32", "i32", "i32", "u32"], result: "i32" },
});
// lib.symbols.InitiateSystemShutdownExA(lpMachineName, lpMessage, dwTimeout, bForceAppsClosed, bRebootAfterShutdown, dwReason)
// lpMachineName : LPSTR optional -> "buffer"
// lpMessage : LPSTR optional -> "buffer"
// dwTimeout : DWORD -> "u32"
// bForceAppsClosed : BOOL -> "i32"
// bRebootAfterShutdown : BOOL -> "i32"
// dwReason : SHUTDOWN_REASON -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t InitiateSystemShutdownExA(
    const char* lpMachineName,
    const char* lpMessage,
    uint32_t dwTimeout,
    int32_t bForceAppsClosed,
    int32_t bRebootAfterShutdown,
    uint32_t dwReason);
C, "ADVAPI32.dll");
// $ffi->InitiateSystemShutdownExA(lpMachineName, lpMessage, dwTimeout, bForceAppsClosed, bRebootAfterShutdown, dwReason);
// lpMachineName : LPSTR optional
// lpMessage : LPSTR optional
// dwTimeout : DWORD
// bForceAppsClosed : BOOL
// bRebootAfterShutdown : BOOL
// 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 Advapi32 extends StdCallLibrary {
    Advapi32 INSTANCE = Native.load("advapi32", Advapi32.class, W32APIOptions.ASCII_OPTIONS);
    boolean InitiateSystemShutdownExA(
        String lpMachineName,   // LPSTR optional
        String lpMessage,   // LPSTR optional
        int dwTimeout,   // DWORD
        boolean bForceAppsClosed,   // BOOL
        boolean bRebootAfterShutdown,   // BOOL
        int dwReason   // SHUTDOWN_REASON
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun InitiateSystemShutdownExA = InitiateSystemShutdownExA(
    lpMachineName : UInt8*,   # LPSTR optional
    lpMessage : UInt8*,   # LPSTR optional
    dwTimeout : UInt32,   # DWORD
    bForceAppsClosed : Int32,   # BOOL
    bRebootAfterShutdown : Int32,   # BOOL
    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 InitiateSystemShutdownExANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Uint32, Int32, Int32, Uint32);
typedef InitiateSystemShutdownExADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int, int, int, int);
final InitiateSystemShutdownExA = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<InitiateSystemShutdownExANative, InitiateSystemShutdownExADart>('InitiateSystemShutdownExA');
// lpMachineName : LPSTR optional -> Pointer<Utf8>
// lpMessage : LPSTR optional -> Pointer<Utf8>
// dwTimeout : DWORD -> Uint32
// bForceAppsClosed : BOOL -> Int32
// bRebootAfterShutdown : BOOL -> Int32
// dwReason : SHUTDOWN_REASON -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function InitiateSystemShutdownExA(
  lpMachineName: PAnsiChar;   // LPSTR optional
  lpMessage: PAnsiChar;   // LPSTR optional
  dwTimeout: DWORD;   // DWORD
  bForceAppsClosed: BOOL;   // BOOL
  bRebootAfterShutdown: BOOL;   // BOOL
  dwReason: DWORD   // SHUTDOWN_REASON
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'InitiateSystemShutdownExA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "InitiateSystemShutdownExA"
  c_InitiateSystemShutdownExA :: CString -> CString -> Word32 -> CInt -> CInt -> Word32 -> IO CInt
-- lpMachineName : LPSTR optional -> CString
-- lpMessage : LPSTR optional -> CString
-- dwTimeout : DWORD -> Word32
-- bForceAppsClosed : BOOL -> CInt
-- bRebootAfterShutdown : BOOL -> CInt
-- dwReason : SHUTDOWN_REASON -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let initiatesystemshutdownexa =
  foreign "InitiateSystemShutdownExA"
    (string @-> string @-> uint32_t @-> int32_t @-> int32_t @-> uint32_t @-> returning int32_t)
(* lpMachineName : LPSTR optional -> string *)
(* lpMessage : LPSTR optional -> string *)
(* dwTimeout : DWORD -> uint32_t *)
(* bForceAppsClosed : BOOL -> int32_t *)
(* bRebootAfterShutdown : BOOL -> int32_t *)
(* dwReason : SHUTDOWN_REASON -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("InitiateSystemShutdownExA" initiate-system-shutdown-ex-a :convention :stdcall) :int32
  (lp-machine-name :string)   ; LPSTR optional
  (lp-message :string)   ; LPSTR optional
  (dw-timeout :uint32)   ; DWORD
  (b-force-apps-closed :int32)   ; BOOL
  (b-reboot-after-shutdown :int32)   ; BOOL
  (dw-reason :uint32))   ; SHUTDOWN_REASON
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $InitiateSystemShutdownExA = Win32::API::More->new('ADVAPI32',
    'BOOL InitiateSystemShutdownExA(LPCSTR lpMachineName, LPCSTR lpMessage, DWORD dwTimeout, BOOL bForceAppsClosed, BOOL bRebootAfterShutdown, DWORD dwReason)');
# my $ret = $InitiateSystemShutdownExA->Call($lpMachineName, $lpMessage, $dwTimeout, $bForceAppsClosed, $bRebootAfterShutdown, $dwReason);
# lpMachineName : LPSTR optional -> LPCSTR
# lpMessage : LPSTR optional -> LPCSTR
# dwTimeout : DWORD -> DWORD
# bForceAppsClosed : BOOL -> BOOL
# bRebootAfterShutdown : BOOL -> BOOL
# dwReason : SHUTDOWN_REASON -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
類似 API
使用する型