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

SetProcessShutdownParameters

関数
プロセスのシャットダウン順位とフラグを設定する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

BOOL SetProcessShutdownParameters(
    DWORD dwLevel,
    DWORD dwFlags
);

パラメーター

名前方向説明
dwLevelDWORDin

システム内の他のプロセスに対する、当該プロセスのシャットダウン優先度です。システムは dwLevel の値が高いものから低いものへとプロセスをシャットダウンします。最も高いシャットダウン優先度と最も低いシャットダウン優先度はシステムコンポーネント用に予約されています。このパラメーターは次の範囲の値でなければなりません。

意味
000-0FF
システム予約の最後のシャットダウン範囲。
100-1FF
アプリケーション予約の最後のシャットダウン範囲。
200-2FF
アプリケーション予約の「中間」のシャットダウン範囲。
300-3FF
アプリケーション予約の最初のシャットダウン範囲。
400-4FF
システム予約の最初のシャットダウン範囲。

すべてのプロセスはシャットダウンレベル 0x280 から開始します。

dwFlagsDWORDin

このパラメーターには次の値を指定できます。

意味
SHUTDOWN_NORETRY
0x00000001
システムは、ユーザーに再試行ダイアログボックスを表示せずにプロセスを終了します。

戻り値の型: BOOL

公式ドキュメント

現在呼び出しているプロセスのシャットダウンパラメーターを設定します。この関数は、システム内の他のプロセスに対する相対的なシャットダウン順序をプロセスに設定します。

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

システムセキュリティコンテキストで実行されているアプリケーションは、オペレーティングシステムによってシャットダウンされません。これらのアプリケーションは、 SetConsoleCtrlHandler を介してインストール可能なコールバック関数を通じて、シャットダウンまたはログオフの通知を受け取ります。また、dwLevel パラメーターで指定された順序で通知されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

BOOL SetProcessShutdownParameters(
    DWORD dwLevel,
    DWORD dwFlags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetProcessShutdownParameters(
    uint dwLevel,   // DWORD
    uint dwFlags   // DWORD
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetProcessShutdownParameters(
    dwLevel As UInteger,   ' DWORD
    dwFlags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' dwLevel : DWORD
' dwFlags : DWORD
Declare PtrSafe Function SetProcessShutdownParameters Lib "kernel32" ( _
    ByVal dwLevel As Long, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetProcessShutdownParameters = ctypes.windll.kernel32.SetProcessShutdownParameters
SetProcessShutdownParameters.restype = wintypes.BOOL
SetProcessShutdownParameters.argtypes = [
    wintypes.DWORD,  # dwLevel : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetProcessShutdownParameters = Fiddle::Function.new(
  lib['SetProcessShutdownParameters'],
  [
    -Fiddle::TYPE_INT,  # dwLevel : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetProcessShutdownParameters(
        dwLevel: u32,  // DWORD
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool SetProcessShutdownParameters(uint dwLevel, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetProcessShutdownParameters' -Namespace Win32 -PassThru
# $api::SetProcessShutdownParameters(dwLevel, dwFlags)
#uselib "KERNEL32.dll"
#func global SetProcessShutdownParameters "SetProcessShutdownParameters" sptr, sptr
; SetProcessShutdownParameters dwLevel, dwFlags   ; 戻り値は stat
; dwLevel : DWORD -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetProcessShutdownParameters "SetProcessShutdownParameters" int, int
; res = SetProcessShutdownParameters(dwLevel, dwFlags)
; dwLevel : DWORD -> "int"
; dwFlags : DWORD -> "int"
; BOOL SetProcessShutdownParameters(DWORD dwLevel, DWORD dwFlags)
#uselib "KERNEL32.dll"
#cfunc global SetProcessShutdownParameters "SetProcessShutdownParameters" int, int
; res = SetProcessShutdownParameters(dwLevel, dwFlags)
; dwLevel : DWORD -> "int"
; dwFlags : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetProcessShutdownParameters = kernel32.NewProc("SetProcessShutdownParameters")
)

// dwLevel (DWORD), dwFlags (DWORD)
r1, _, err := procSetProcessShutdownParameters.Call(
	uintptr(dwLevel),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetProcessShutdownParameters(
  dwLevel: DWORD;   // DWORD
  dwFlags: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetProcessShutdownParameters';
result := DllCall("KERNEL32\SetProcessShutdownParameters"
    , "UInt", dwLevel   ; DWORD
    , "UInt", dwFlags   ; DWORD
    , "Int")   ; return: BOOL
●SetProcessShutdownParameters(dwLevel, dwFlags) = DLL("KERNEL32.dll", "bool SetProcessShutdownParameters(dword, dword)")
# 呼び出し: SetProcessShutdownParameters(dwLevel, dwFlags)
# dwLevel : DWORD -> "dword"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn SetProcessShutdownParameters(
    dwLevel: u32, // DWORD
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc SetProcessShutdownParameters(
    dwLevel: uint32,  # DWORD
    dwFlags: uint32  # DWORD
): int32 {.importc: "SetProcessShutdownParameters", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int SetProcessShutdownParameters(
    uint dwLevel,   // DWORD
    uint dwFlags   // DWORD
);
ccall((:SetProcessShutdownParameters, "KERNEL32.dll"), stdcall, Int32,
      (UInt32, UInt32),
      dwLevel, dwFlags)
# dwLevel : DWORD -> UInt32
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetProcessShutdownParameters(
    uint32_t dwLevel,
    uint32_t dwFlags);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetProcessShutdownParameters(dwLevel, dwFlags)
-- dwLevel : DWORD
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetProcessShutdownParameters = lib.func('__stdcall', 'SetProcessShutdownParameters', 'int32_t', ['uint32_t', 'uint32_t']);
// SetProcessShutdownParameters(dwLevel, dwFlags)
// dwLevel : DWORD -> 'uint32_t'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  SetProcessShutdownParameters: { parameters: ["u32", "u32"], result: "i32" },
});
// lib.symbols.SetProcessShutdownParameters(dwLevel, dwFlags)
// dwLevel : DWORD -> "u32"
// dwFlags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetProcessShutdownParameters(
    uint32_t dwLevel,
    uint32_t dwFlags);
C, "KERNEL32.dll");
// $ffi->SetProcessShutdownParameters(dwLevel, dwFlags);
// dwLevel : DWORD
// dwFlags : DWORD
// 構造体/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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    boolean SetProcessShutdownParameters(
        int dwLevel,   // DWORD
        int dwFlags   // DWORD
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun SetProcessShutdownParameters = SetProcessShutdownParameters(
    dwLevel : UInt32,   # DWORD
    dwFlags : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetProcessShutdownParametersNative = Int32 Function(Uint32, Uint32);
typedef SetProcessShutdownParametersDart = int Function(int, int);
final SetProcessShutdownParameters = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetProcessShutdownParametersNative, SetProcessShutdownParametersDart>('SetProcessShutdownParameters');
// dwLevel : DWORD -> Uint32
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetProcessShutdownParameters(
  dwLevel: DWORD;   // DWORD
  dwFlags: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetProcessShutdownParameters';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetProcessShutdownParameters"
  c_SetProcessShutdownParameters :: Word32 -> Word32 -> IO CInt
-- dwLevel : DWORD -> Word32
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setprocessshutdownparameters =
  foreign "SetProcessShutdownParameters"
    (uint32_t @-> uint32_t @-> returning int32_t)
(* dwLevel : DWORD -> uint32_t *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("SetProcessShutdownParameters" set-process-shutdown-parameters :convention :stdcall) :int32
  (dw-level :uint32)   ; DWORD
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetProcessShutdownParameters = Win32::API::More->new('KERNEL32',
    'BOOL SetProcessShutdownParameters(DWORD dwLevel, DWORD dwFlags)');
# my $ret = $SetProcessShutdownParameters->Call($dwLevel, $dwFlags);
# dwLevel : DWORD -> DWORD
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目