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

InitiateSystemShutdownW

関数
指定マシンのシステムシャットダウンを開始する。
DLLADVAPI32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL InitiateSystemShutdownW(
    LPWSTR lpMachineName,   // optional
    LPWSTR lpMessage,   // optional
    DWORD dwTimeout,
    BOOL bForceAppsClosed,
    BOOL bRebootAfterShutdown
);

パラメーター

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

戻り値の型: BOOL

各言語での呼び出し定義

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL InitiateSystemShutdownW(
    LPWSTR lpMachineName,   // optional
    LPWSTR lpMessage,   // optional
    DWORD dwTimeout,
    BOOL bForceAppsClosed,
    BOOL bRebootAfterShutdown
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool InitiateSystemShutdownW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpMachineName,   // LPWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpMessage,   // LPWSTR optional
    uint dwTimeout,   // DWORD
    bool bForceAppsClosed,   // BOOL
    bool bRebootAfterShutdown   // BOOL
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InitiateSystemShutdownW(
    <MarshalAs(UnmanagedType.LPWStr)> lpMachineName As String,   ' LPWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> lpMessage As String,   ' LPWSTR optional
    dwTimeout As UInteger,   ' DWORD
    bForceAppsClosed As Boolean,   ' BOOL
    bRebootAfterShutdown As Boolean   ' BOOL
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpMachineName : LPWSTR optional
' lpMessage : LPWSTR optional
' dwTimeout : DWORD
' bForceAppsClosed : BOOL
' bRebootAfterShutdown : BOOL
Declare PtrSafe Function InitiateSystemShutdownW Lib "advapi32" ( _
    ByVal lpMachineName As LongPtr, _
    ByVal lpMessage As LongPtr, _
    ByVal dwTimeout As Long, _
    ByVal bForceAppsClosed As Long, _
    ByVal bRebootAfterShutdown As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procInitiateSystemShutdownW = advapi32.NewProc("InitiateSystemShutdownW")
)

// lpMachineName (LPWSTR optional), lpMessage (LPWSTR optional), dwTimeout (DWORD), bForceAppsClosed (BOOL), bRebootAfterShutdown (BOOL)
r1, _, err := procInitiateSystemShutdownW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpMachineName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpMessage))),
	uintptr(dwTimeout),
	uintptr(bForceAppsClosed),
	uintptr(bRebootAfterShutdown),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function InitiateSystemShutdownW(
  lpMachineName: PWideChar;   // LPWSTR optional
  lpMessage: PWideChar;   // LPWSTR optional
  dwTimeout: DWORD;   // DWORD
  bForceAppsClosed: BOOL;   // BOOL
  bRebootAfterShutdown: BOOL   // BOOL
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'InitiateSystemShutdownW';
result := DllCall("ADVAPI32\InitiateSystemShutdownW"
    , "WStr", lpMachineName   ; LPWSTR optional
    , "WStr", lpMessage   ; LPWSTR optional
    , "UInt", dwTimeout   ; DWORD
    , "Int", bForceAppsClosed   ; BOOL
    , "Int", bRebootAfterShutdown   ; BOOL
    , "Int")   ; return: BOOL
●InitiateSystemShutdownW(lpMachineName, lpMessage, dwTimeout, bForceAppsClosed, bRebootAfterShutdown) = DLL("ADVAPI32.dll", "bool InitiateSystemShutdownW(char*, char*, dword, bool, bool)")
# 呼び出し: InitiateSystemShutdownW(lpMachineName, lpMessage, dwTimeout, bForceAppsClosed, bRebootAfterShutdown)
# lpMachineName : LPWSTR optional -> "char*"
# lpMessage : LPWSTR optional -> "char*"
# dwTimeout : DWORD -> "dword"
# bForceAppsClosed : BOOL -> "bool"
# bRebootAfterShutdown : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "advapi32" fn InitiateSystemShutdownW(
    lpMachineName: [*c]const u16, // LPWSTR optional
    lpMessage: [*c]const u16, // LPWSTR optional
    dwTimeout: u32, // DWORD
    bForceAppsClosed: i32, // BOOL
    bRebootAfterShutdown: i32 // BOOL
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc InitiateSystemShutdownW(
    lpMachineName: WideCString,  # LPWSTR optional
    lpMessage: WideCString,  # LPWSTR optional
    dwTimeout: uint32,  # DWORD
    bForceAppsClosed: int32,  # BOOL
    bRebootAfterShutdown: int32  # BOOL
): int32 {.importc: "InitiateSystemShutdownW", stdcall, dynlib: "ADVAPI32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "advapi32");
extern(Windows)
int InitiateSystemShutdownW(
    const(wchar)* lpMachineName,   // LPWSTR optional
    const(wchar)* lpMessage,   // LPWSTR optional
    uint dwTimeout,   // DWORD
    int bForceAppsClosed,   // BOOL
    int bRebootAfterShutdown   // BOOL
);
ccall((:InitiateSystemShutdownW, "ADVAPI32.dll"), stdcall, Int32,
      (Cwstring, Cwstring, UInt32, Int32, Int32),
      lpMachineName, lpMessage, dwTimeout, bForceAppsClosed, bRebootAfterShutdown)
# lpMachineName : LPWSTR optional -> Cwstring
# lpMessage : LPWSTR optional -> Cwstring
# dwTimeout : DWORD -> UInt32
# bForceAppsClosed : BOOL -> Int32
# bRebootAfterShutdown : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t InitiateSystemShutdownW(
    const uint16_t* lpMachineName,
    const uint16_t* lpMessage,
    uint32_t dwTimeout,
    int32_t bForceAppsClosed,
    int32_t bRebootAfterShutdown);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.InitiateSystemShutdownW(lpMachineName, lpMessage, dwTimeout, bForceAppsClosed, bRebootAfterShutdown)
-- lpMachineName : LPWSTR optional
-- lpMessage : LPWSTR optional
-- dwTimeout : DWORD
-- bForceAppsClosed : BOOL
-- bRebootAfterShutdown : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const InitiateSystemShutdownW = lib.func('__stdcall', 'InitiateSystemShutdownW', 'int32_t', ['str16', 'str16', 'uint32_t', 'int32_t', 'int32_t']);
// InitiateSystemShutdownW(lpMachineName, lpMessage, dwTimeout, bForceAppsClosed, bRebootAfterShutdown)
// lpMachineName : LPWSTR optional -> 'str16'
// lpMessage : LPWSTR optional -> 'str16'
// dwTimeout : DWORD -> 'uint32_t'
// bForceAppsClosed : BOOL -> 'int32_t'
// bRebootAfterShutdown : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  InitiateSystemShutdownW: { parameters: ["buffer", "buffer", "u32", "i32", "i32"], result: "i32" },
});
// lib.symbols.InitiateSystemShutdownW(lpMachineName, lpMessage, dwTimeout, bForceAppsClosed, bRebootAfterShutdown)
// lpMachineName : LPWSTR optional -> "buffer"
// lpMessage : LPWSTR optional -> "buffer"
// dwTimeout : DWORD -> "u32"
// bForceAppsClosed : BOOL -> "i32"
// bRebootAfterShutdown : BOOL -> "i32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t InitiateSystemShutdownW(
    const uint16_t* lpMachineName,
    const uint16_t* lpMessage,
    uint32_t dwTimeout,
    int32_t bForceAppsClosed,
    int32_t bRebootAfterShutdown);
C, "ADVAPI32.dll");
// $ffi->InitiateSystemShutdownW(lpMachineName, lpMessage, dwTimeout, bForceAppsClosed, bRebootAfterShutdown);
// lpMachineName : LPWSTR optional
// lpMessage : LPWSTR optional
// dwTimeout : DWORD
// bForceAppsClosed : BOOL
// bRebootAfterShutdown : BOOL
// 構造体/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.UNICODE_OPTIONS);
    boolean InitiateSystemShutdownW(
        WString lpMachineName,   // LPWSTR optional
        WString lpMessage,   // LPWSTR optional
        int dwTimeout,   // DWORD
        boolean bForceAppsClosed,   // BOOL
        boolean bRebootAfterShutdown   // BOOL
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("advapi32")]
lib LibADVAPI32
  fun InitiateSystemShutdownW = InitiateSystemShutdownW(
    lpMachineName : UInt16*,   # LPWSTR optional
    lpMessage : UInt16*,   # LPWSTR optional
    dwTimeout : UInt32,   # DWORD
    bForceAppsClosed : Int32,   # BOOL
    bRebootAfterShutdown : Int32   # BOOL
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef InitiateSystemShutdownWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Uint32, Int32, Int32);
typedef InitiateSystemShutdownWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int, int, int);
final InitiateSystemShutdownW = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<InitiateSystemShutdownWNative, InitiateSystemShutdownWDart>('InitiateSystemShutdownW');
// lpMachineName : LPWSTR optional -> Pointer<Utf16>
// lpMessage : LPWSTR optional -> Pointer<Utf16>
// dwTimeout : DWORD -> Uint32
// bForceAppsClosed : BOOL -> Int32
// bRebootAfterShutdown : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function InitiateSystemShutdownW(
  lpMachineName: PWideChar;   // LPWSTR optional
  lpMessage: PWideChar;   // LPWSTR optional
  dwTimeout: DWORD;   // DWORD
  bForceAppsClosed: BOOL;   // BOOL
  bRebootAfterShutdown: BOOL   // BOOL
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'InitiateSystemShutdownW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

(cffi:defcfun ("InitiateSystemShutdownW" initiate-system-shutdown-w :convention :stdcall) :int32
  (lp-machine-name (:string :encoding :utf-16le))   ; LPWSTR optional
  (lp-message (:string :encoding :utf-16le))   ; LPWSTR optional
  (dw-timeout :uint32)   ; DWORD
  (b-force-apps-closed :int32)   ; BOOL
  (b-reboot-after-shutdown :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $InitiateSystemShutdownW = Win32::API::More->new('ADVAPI32',
    'BOOL InitiateSystemShutdownW(LPCWSTR lpMachineName, LPCWSTR lpMessage, DWORD dwTimeout, BOOL bForceAppsClosed, BOOL bRebootAfterShutdown)');
# my $ret = $InitiateSystemShutdownW->Call($lpMachineName, $lpMessage, $dwTimeout, $bForceAppsClosed, $bRebootAfterShutdown);
# lpMachineName : LPWSTR optional -> LPCWSTR
# lpMessage : LPWSTR optional -> LPCWSTR
# dwTimeout : DWORD -> DWORD
# bForceAppsClosed : BOOL -> BOOL
# bRebootAfterShutdown : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API