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

InitiateSystemShutdownExA

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

シグネチャ

// 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
lpMessageLPSTRinoptional
dwTimeoutDWORDin
bForceAppsClosedBOOLin
bRebootAfterShutdownBOOLin
dwReasonSHUTDOWN_REASONin

戻り値の型: 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 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)。