InitiateSystemShutdownW
関数シグネチャ
// ADVAPI32.dll (Unicode / -W)
#include <windows.h>
BOOL InitiateSystemShutdownW(
LPWSTR lpMachineName, // optional
LPWSTR lpMessage, // optional
DWORD dwTimeout,
BOOL bForceAppsClosed,
BOOL bRebootAfterShutdown
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| lpMachineName | LPWSTR | inoptional | シャットダウンするコンピューターのネットワーク名。lpMachineName が NULL または空の文字列の場合、この関数はローカルコンピューターをシャットダウンします。 |
| lpMessage | LPWSTR | inoptional | シャットダウンダイアログボックスに表示するメッセージ。メッセージが不要な場合、このパラメーターには NULL を指定できます。 Windows Server 2003 および Windows XP: この文字列は、イベントログのエントリにコメントとしても記録されます。 Windows Server 2003 および Windows XP with SP1: この文字列は 3072 TCHARs までに制限されます。 |
| dwTimeout | DWORD | in | シャットダウンダイアログボックスを表示する時間 (秒単位)。このダイアログボックスが表示されている間は、 AbortSystemShutdown 関数によってシャットダウンを中止できます。 dwTimeout が 0 以外の場合、 InitiateSystemShutdown は指定したコンピューター上にダイアログボックスを表示します。ダイアログボックスには、この関数を呼び出したユーザーの名前と lpMessage パラメーターで指定したメッセージが表示され、ログオフするようユーザーに促します。ダイアログボックスは作成時にビープ音を鳴らし、システム内の他のウィンドウの最前面に表示され続けます。ダイアログボックスは移動できますが、閉じることはできません。強制シャットダウンまでの残り時間は、タイマーによってカウントダウンされます。 dwTimeout が 0 の場合、コンピューターはダイアログボックスを表示せずにシャットダウンし、 AbortSystemShutdown によってシャットダウンを中止することはできません。 Windows Server 2003 および Windows XP with SP1: タイムアウト値は MAX_SHUTDOWN_TIMEOUT 秒までに制限されます。 Windows Server 2003 および Windows XP with SP1: シャットダウンするコンピューターがターミナルサービスサーバーの場合、システムはローカルおよびリモートのすべてのユーザーに対して、シャットダウンが開始されたことを警告するダイアログボックスを表示します。このダイアログボックスには、シャットダウンを要求したユーザー、表示メッセージ (lpMessage を参照)、およびサーバーがシャットダウンされるまでの残り時間が示されます。 |
| bForceAppsClosed | BOOL | in | このパラメーターが TRUE の場合、保存されていない変更を持つアプリケーションは強制的に閉じられます。この場合、データが失われる可能性があることに注意してください。 このパラメーターが FALSE の場合、システムはアプリケーションを閉じるようユーザーに指示するダイアログボックスを表示します。 |
| bRebootAfterShutdown | BOOL | in | このパラメーターが TRUE の場合、コンピューターはシャットダウン後ただちに再起動します。このパラメーターが FALSE の場合、システムはすべてのキャッシュをディスクにフラッシュし、システムの電源を安全に切ります。 |
戻り値の型: BOOL
公式ドキュメント
指定したコンピューターのシャットダウン、および必要に応じて再起動を開始します。(Unicode)
戻り値
関数が成功した場合、戻り値は 0 以外の値です。
関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。
解説(Remarks)
ローカルコンピューターをシャットダウンするには、呼び出し元のスレッドが SE_SHUTDOWN_NAME 特権を持っている必要があります。リモートコンピューターをシャットダウンするには、呼び出し元のスレッドがそのリモートコンピューター上で SE_REMOTE_SHUTDOWN_NAME 特権を持っている必要があります。既定では、ユーザーは自分がログオンしているコンピューター上で SE_SHUTDOWN_NAME 特権を有効にでき、管理者はリモートコンピューター上で SE_REMOTE_SHUTDOWN_NAME 特権を有効にできます。詳細については、 Running with Special Privileges を参照してください。
失敗の一般的な原因としては、コンピューター名が無効またはアクセス不能であること、あるいは特権が不足していることが挙げられます。指定したコンピューター上で既にシャットダウンが進行中の場合は、エラー ERROR_SHUTDOWN_IN_PROGRESS が返されます。高速ユーザー切り替えが有効になっているものの、どのユーザーもログオンしていない場合は、エラー ERROR_NOT_READY が返されることがあります。
戻り値が 0 以外であっても、ログオフが成功した、または成功することを意味するわけではありません。シャットダウンは非同期の処理であり、API の呼び出しが復帰してからかなり後に発生することも、まったく発生しないこともあります。タイムアウト値が 0 であっても、アプリケーション、サービス、あるいはシステム自体によってシャットダウンが中止される場合があります。0 以外の戻り値は、権限とパラメーターの検証に成功し、システムがシャットダウン要求を受け付けたことを示します。
この関数を呼び出す際、呼び出し元は、保存されていない変更を持つアプリケーションを強制的に閉じるかどうかを指定する必要があります。呼び出し元がこれらのアプリケーションを強制的に閉じないことを選択し、かつ保存されていない変更を持つアプリケーションがコンソールセッションで実行されている場合、シャットダウンは進行中のまま維持されます。この状態は、コンソールセッションにログオンしているユーザーがシャットダウンを中止するか、変更を保存するか、アプリケーションを閉じるか、アプリケーションを強制的に閉じるまで続きます。この間、シャットダウンはコンソールユーザー以外は中止できず、別のシャットダウンを開始することもできません。
bForceAppsClosed パラメーターに TRUE を指定してこの関数を呼び出せば、この状況を回避できます。ただし、そうした場合はデータが失われる可能性があることに注意してください。
Windows Server 2003 および Windows XP: コンピューターがロックされていて bForceAppsClosed パラメーターが FALSE の場合、最終エラーコードは ERROR_MACHINE_LOCKED になります。システムが要求を処理できる状態にない場合、最終エラーコードは ERROR_NOT_READY になります。アプリケーションは少し待ってから呼び出しを再試行してください。たとえば、ユーザーがシステムにログオンしようとしているのと同時にシャットダウン要求が行われた場合、システムはシャットダウンを開始できず、ERROR_NOT_READY を返すことがあります。この場合、アプリケーションは少し待ってから呼び出しを再試行してください。
例
例については、 Displaying the Shutdown Dialog Box を参照してください。
winreg.h ヘッダーは、UNICODE プリプロセッサ定数の定義に応じて、この関数の ANSI 版と Unicode 版を自動的に選択するエイリアスとして InitiateSystemShutdown を定義します。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、不整合が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// 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 // BOOLfunction 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 変換を行う。関連項目
- f InitiateSystemShutdownA (ANSI版) — 指定マシンのシステムシャットダウンを開始する。
- f InitiateSystemShutdownExW — 理由コード付きでシステムシャットダウンを開始する。
- f AbortSystemShutdownW — 進行中のシステムシャットダウンを中止する。