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

InitiateShutdownW

関数
フラグと理由を指定してシャットダウンや再起動を開始する。
DLLADVAPI32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD InitiateShutdownW(
    LPWSTR lpMachineName,   // optional
    LPWSTR lpMessage,   // optional
    DWORD dwGracePeriod,
    SHUTDOWN_FLAGS dwShutdownFlags,
    SHUTDOWN_REASON dwReason
);

パラメーター

名前方向説明
lpMachineNameLPWSTRinoptionalシャットダウン対象のコンピュータ名。NULLでローカルマシン。
lpMessageLPWSTRinoptionalユーザーに表示する警告メッセージ。NULL可。
dwGracePeriodDWORDinシャットダウン開始までの猶予時間(秒)。
dwShutdownFlagsSHUTDOWN_FLAGSinシャットダウン動作を指定するフラグ。SHUTDOWN_*の組み合わせ。
dwReasonSHUTDOWN_REASONinシャットダウン理由コード。SHTDN_REASON_*の組み合わせ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD InitiateShutdownW(
    LPWSTR lpMachineName,   // optional
    LPWSTR lpMessage,   // optional
    DWORD dwGracePeriod,
    SHUTDOWN_FLAGS dwShutdownFlags,
    SHUTDOWN_REASON dwReason
);
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint InitiateShutdownW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpMachineName,   // LPWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpMessage,   // LPWSTR optional
    uint dwGracePeriod,   // DWORD
    uint dwShutdownFlags,   // SHUTDOWN_FLAGS
    uint dwReason   // SHUTDOWN_REASON
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function InitiateShutdownW(
    <MarshalAs(UnmanagedType.LPWStr)> lpMachineName As String,   ' LPWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> lpMessage As String,   ' LPWSTR optional
    dwGracePeriod As UInteger,   ' DWORD
    dwShutdownFlags As UInteger,   ' SHUTDOWN_FLAGS
    dwReason As UInteger   ' SHUTDOWN_REASON
) As UInteger
End Function
' lpMachineName : LPWSTR optional
' lpMessage : LPWSTR optional
' dwGracePeriod : DWORD
' dwShutdownFlags : SHUTDOWN_FLAGS
' dwReason : SHUTDOWN_REASON
Declare PtrSafe Function InitiateShutdownW Lib "advapi32" ( _
    ByVal lpMachineName As LongPtr, _
    ByVal lpMessage As LongPtr, _
    ByVal dwGracePeriod As Long, _
    ByVal dwShutdownFlags As Long, _
    ByVal dwReason 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

InitiateShutdownW = ctypes.windll.advapi32.InitiateShutdownW
InitiateShutdownW.restype = wintypes.DWORD
InitiateShutdownW.argtypes = [
    wintypes.LPCWSTR,  # lpMachineName : LPWSTR optional
    wintypes.LPCWSTR,  # lpMessage : LPWSTR optional
    wintypes.DWORD,  # dwGracePeriod : DWORD
    wintypes.DWORD,  # dwShutdownFlags : SHUTDOWN_FLAGS
    wintypes.DWORD,  # dwReason : SHUTDOWN_REASON
]
require 'fiddle'
require 'fiddle/import'

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

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procInitiateShutdownW = advapi32.NewProc("InitiateShutdownW")
)

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

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

typedef InitiateShutdownWNative = Uint32 Function(Pointer<Utf16>, Pointer<Utf16>, Uint32, Uint32, Uint32);
typedef InitiateShutdownWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int, int, int);
final InitiateShutdownW = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<InitiateShutdownWNative, InitiateShutdownWDart>('InitiateShutdownW');
// lpMachineName : LPWSTR optional -> Pointer<Utf16>
// lpMessage : LPWSTR optional -> Pointer<Utf16>
// dwGracePeriod : DWORD -> Uint32
// dwShutdownFlags : SHUTDOWN_FLAGS -> Uint32
// dwReason : SHUTDOWN_REASON -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function InitiateShutdownW(
  lpMachineName: PWideChar;   // LPWSTR optional
  lpMessage: PWideChar;   // LPWSTR optional
  dwGracePeriod: DWORD;   // DWORD
  dwShutdownFlags: DWORD;   // SHUTDOWN_FLAGS
  dwReason: DWORD   // SHUTDOWN_REASON
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'InitiateShutdownW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "InitiateShutdownW"
  c_InitiateShutdownW :: CWString -> CWString -> Word32 -> Word32 -> Word32 -> IO Word32
-- lpMachineName : LPWSTR optional -> CWString
-- lpMessage : LPWSTR optional -> CWString
-- dwGracePeriod : DWORD -> Word32
-- dwShutdownFlags : SHUTDOWN_FLAGS -> Word32
-- dwReason : SHUTDOWN_REASON -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let initiateshutdownw =
  foreign "InitiateShutdownW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> uint32_t @-> uint32_t @-> returning uint32_t)
(* lpMachineName : LPWSTR optional -> (ptr uint16_t) *)
(* lpMessage : LPWSTR optional -> (ptr uint16_t) *)
(* dwGracePeriod : DWORD -> uint32_t *)
(* dwShutdownFlags : SHUTDOWN_FLAGS -> uint32_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 ("InitiateShutdownW" initiate-shutdown-w :convention :stdcall) :uint32
  (lp-machine-name (:string :encoding :utf-16le))   ; LPWSTR optional
  (lp-message (:string :encoding :utf-16le))   ; LPWSTR optional
  (dw-grace-period :uint32)   ; DWORD
  (dw-shutdown-flags :uint32)   ; SHUTDOWN_FLAGS
  (dw-reason :uint32))   ; SHUTDOWN_REASON
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $InitiateShutdownW = Win32::API::More->new('ADVAPI32',
    'DWORD InitiateShutdownW(LPCWSTR lpMachineName, LPCWSTR lpMessage, DWORD dwGracePeriod, DWORD dwShutdownFlags, DWORD dwReason)');
# my $ret = $InitiateShutdownW->Call($lpMachineName, $lpMessage, $dwGracePeriod, $dwShutdownFlags, $dwReason);
# lpMachineName : LPWSTR optional -> LPCWSTR
# lpMessage : LPWSTR optional -> LPCWSTR
# dwGracePeriod : DWORD -> DWORD
# dwShutdownFlags : SHUTDOWN_FLAGS -> DWORD
# dwReason : SHUTDOWN_REASON -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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