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

SetSystemPowerState

関数
システムをサスペンドまたは休止状態に設定する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL SetSystemPowerState(
    BOOL fSuspend,
    BOOL fForce
);

パラメーター

名前方向説明
fSuspendBOOLinこのパラメーターが TRUE の場合、システムはサスペンドされます。FALSE の場合、システムは休止状態になります。
fForceBOOLinこのパラメーターは効果がありません。

戻り値の型: BOOL

公式ドキュメント

電源を切断してシステムをサスペンドします。ForceFlag パラメーターに応じて、この関数は動作を即座にサスペンドするか、サスペンドする前にすべてのアプリケーションおよびデバイスドライバーに許可を要求します。

戻り値

電源がサスペンドされ、その後復元された場合、戻り値は 0 以外になります。

システムがサスペンドされなかった場合、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

呼び出し元のプロセスは SE_SHUTDOWN_NAME 特権を持っている必要があります。SE_SHUTDOWN_NAME 特権を有効にするには、AdjustTokenPrivileges 関数を使用します。詳細については、Changing Privileges in a Token を参照してください。

いずれかのアプリケーションまたはドライバーが動作のサスペンドを拒否した場合、この関数は各アプリケーションおよびドライバーに PBT_APMQUERYSUSPENDFAILED イベントをブロードキャストします。電源がサスペンドされた場合、この関数はシステムの動作が再開され、関連する WM_POWERBROADCAST メッセージがすべてのアプリケーションおよびドライバーにブロードキャストされた後にのみ返ります。

この関数は SetSuspendState 関数に似ています。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT マクロを 0x0400 以降として定義します。詳細については、Using the Windows Headers を参照してください。

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

各言語での呼び出し定義

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

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

SetSystemPowerState = ctypes.windll.kernel32.SetSystemPowerState
SetSystemPowerState.restype = wintypes.BOOL
SetSystemPowerState.argtypes = [
    wintypes.BOOL,  # fSuspend : BOOL
    wintypes.BOOL,  # fForce : BOOL
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetSystemPowerState = Fiddle::Function.new(
  lib['SetSystemPowerState'],
  [
    Fiddle::TYPE_INT,  # fSuspend : BOOL
    Fiddle::TYPE_INT,  # fForce : BOOL
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetSystemPowerState(
        fSuspend: i32,  // BOOL
        fForce: i32  // BOOL
    ) -> 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 SetSystemPowerState(bool fSuspend, bool fForce);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetSystemPowerState' -Namespace Win32 -PassThru
# $api::SetSystemPowerState(fSuspend, fForce)
#uselib "KERNEL32.dll"
#func global SetSystemPowerState "SetSystemPowerState" sptr, sptr
; SetSystemPowerState fSuspend, fForce   ; 戻り値は stat
; fSuspend : BOOL -> "sptr"
; fForce : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetSystemPowerState "SetSystemPowerState" int, int
; res = SetSystemPowerState(fSuspend, fForce)
; fSuspend : BOOL -> "int"
; fForce : BOOL -> "int"
; BOOL SetSystemPowerState(BOOL fSuspend, BOOL fForce)
#uselib "KERNEL32.dll"
#cfunc global SetSystemPowerState "SetSystemPowerState" int, int
; res = SetSystemPowerState(fSuspend, fForce)
; fSuspend : BOOL -> "int"
; fForce : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetSystemPowerState = kernel32.NewProc("SetSystemPowerState")
)

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

extern "kernel32" fn SetSystemPowerState(
    fSuspend: i32, // BOOL
    fForce: i32 // BOOL
) callconv(std.os.windows.WINAPI) i32;
proc SetSystemPowerState(
    fSuspend: int32,  # BOOL
    fForce: int32  # BOOL
): int32 {.importc: "SetSystemPowerState", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int SetSystemPowerState(
    int fSuspend,   // BOOL
    int fForce   // BOOL
);
ccall((:SetSystemPowerState, "KERNEL32.dll"), stdcall, Int32,
      (Int32, Int32),
      fSuspend, fForce)
# fSuspend : BOOL -> Int32
# fForce : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetSystemPowerState(
    int32_t fSuspend,
    int32_t fForce);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetSystemPowerState(fSuspend, fForce)
-- fSuspend : BOOL
-- fForce : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetSystemPowerState = lib.func('__stdcall', 'SetSystemPowerState', 'int32_t', ['int32_t', 'int32_t']);
// SetSystemPowerState(fSuspend, fForce)
// fSuspend : BOOL -> 'int32_t'
// fForce : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  SetSystemPowerState: { parameters: ["i32", "i32"], result: "i32" },
});
// lib.symbols.SetSystemPowerState(fSuspend, fForce)
// fSuspend : BOOL -> "i32"
// fForce : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetSystemPowerState(
    int32_t fSuspend,
    int32_t fForce);
C, "KERNEL32.dll");
// $ffi->SetSystemPowerState(fSuspend, fForce);
// fSuspend : BOOL
// fForce : 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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    boolean SetSystemPowerState(
        boolean fSuspend,   // BOOL
        boolean fForce   // BOOL
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun SetSystemPowerState = SetSystemPowerState(
    fSuspend : Int32,   # BOOL
    fForce : 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 SetSystemPowerStateNative = Int32 Function(Int32, Int32);
typedef SetSystemPowerStateDart = int Function(int, int);
final SetSystemPowerState = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetSystemPowerStateNative, SetSystemPowerStateDart>('SetSystemPowerState');
// fSuspend : BOOL -> Int32
// fForce : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetSystemPowerState(
  fSuspend: BOOL;   // BOOL
  fForce: BOOL   // BOOL
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetSystemPowerState';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetSystemPowerState"
  c_SetSystemPowerState :: CInt -> CInt -> IO CInt
-- fSuspend : BOOL -> CInt
-- fForce : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("SetSystemPowerState" set-system-power-state :convention :stdcall) :int32
  (f-suspend :int32)   ; BOOL
  (f-force :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetSystemPowerState = Win32::API::More->new('KERNEL32',
    'BOOL SetSystemPowerState(BOOL fSuspend, BOOL fForce)');
# my $ret = $SetSystemPowerState->Call($fSuspend, $fForce);
# fSuspend : BOOL -> BOOL
# fForce : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目