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

SetSuspendState

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

シグネチャ

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

BOOLEAN SetSuspendState(
    BOOLEAN bHibernate,
    BOOLEAN bForce,
    BOOLEAN bWakeupEventsDisabled
);

パラメーター

名前方向説明
bHibernateBOOLEANinこのパラメーターが TRUE の場合、システムは休止状態になります。FALSE の場合、システムはサスペンドされます。
bForceBOOLEANinこのパラメーターは効果を持ちません。
bWakeupEventsDisabledBOOLEANinこのパラメーターが TRUE の場合、システムはすべてのウェイクイベントを無効にします。FALSE の場合、システムのウェイクイベントは有効なまま維持されます。

戻り値の型: BOOLEAN

公式ドキュメント

電源を切断してシステムをサスペンドします。Hibernate パラメーターに応じて、システムはサスペンド(スリープ)状態または休止状態(S4)のいずれかに移行します。

戻り値

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

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

解説(Remarks)

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

アプリケーションは SetSuspendState を使用して、システムを動作状態からスタンバイ(スリープ)状態へ、またはオプションで休止状態(S4)へ遷移させることができます。この関数は SetSystemPowerState 関数に似ています。

PowrProf.h の使用方法の詳細については、Power Schemes を参照してください。システムをウェイクできるイベントについては、System Wake-up Events を参照してください。

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

各言語での呼び出し定義

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

BOOLEAN SetSuspendState(
    BOOLEAN bHibernate,
    BOOLEAN bForce,
    BOOLEAN bWakeupEventsDisabled
);
[return: MarshalAs(UnmanagedType.U1)]
[DllImport("POWRPROF.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetSuspendState(
    [MarshalAs(UnmanagedType.U1)] bool bHibernate,   // BOOLEAN
    [MarshalAs(UnmanagedType.U1)] bool bForce,   // BOOLEAN
    [MarshalAs(UnmanagedType.U1)] bool bWakeupEventsDisabled   // BOOLEAN
);
<DllImport("POWRPROF.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetSuspendState(
    <MarshalAs(UnmanagedType.U1)> bHibernate As Boolean,   ' BOOLEAN
    <MarshalAs(UnmanagedType.U1)> bForce As Boolean,   ' BOOLEAN
    <MarshalAs(UnmanagedType.U1)> bWakeupEventsDisabled As Boolean   ' BOOLEAN
) As <MarshalAs(UnmanagedType.U1)> Boolean
End Function
' bHibernate : BOOLEAN
' bForce : BOOLEAN
' bWakeupEventsDisabled : BOOLEAN
Declare PtrSafe Function SetSuspendState Lib "powrprof" ( _
    ByVal bHibernate As Byte, _
    ByVal bForce As Byte, _
    ByVal bWakeupEventsDisabled As Byte) As Byte
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetSuspendState = ctypes.windll.powrprof.SetSuspendState
SetSuspendState.restype = wintypes.BOOLEAN
SetSuspendState.argtypes = [
    wintypes.BOOLEAN,  # bHibernate : BOOLEAN
    wintypes.BOOLEAN,  # bForce : BOOLEAN
    wintypes.BOOLEAN,  # bWakeupEventsDisabled : BOOLEAN
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('POWRPROF.dll')
SetSuspendState = Fiddle::Function.new(
  lib['SetSuspendState'],
  [
    Fiddle::TYPE_CHAR,  # bHibernate : BOOLEAN
    Fiddle::TYPE_CHAR,  # bForce : BOOLEAN
    Fiddle::TYPE_CHAR,  # bWakeupEventsDisabled : BOOLEAN
  ],
  Fiddle::TYPE_CHAR)
#[link(name = "powrprof")]
extern "system" {
    fn SetSuspendState(
        bHibernate: u8,  // BOOLEAN
        bForce: u8,  // BOOLEAN
        bWakeupEventsDisabled: u8  // BOOLEAN
    ) -> u8;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.U1)]
[DllImport("POWRPROF.dll", SetLastError = true)]
public static extern bool SetSuspendState([MarshalAs(UnmanagedType.U1)] bool bHibernate, [MarshalAs(UnmanagedType.U1)] bool bForce, [MarshalAs(UnmanagedType.U1)] bool bWakeupEventsDisabled);
"@
$api = Add-Type -MemberDefinition $sig -Name 'POWRPROF_SetSuspendState' -Namespace Win32 -PassThru
# $api::SetSuspendState(bHibernate, bForce, bWakeupEventsDisabled)
#uselib "POWRPROF.dll"
#func global SetSuspendState "SetSuspendState" sptr, sptr, sptr
; SetSuspendState bHibernate, bForce, bWakeupEventsDisabled   ; 戻り値は stat
; bHibernate : BOOLEAN -> "sptr"
; bForce : BOOLEAN -> "sptr"
; bWakeupEventsDisabled : BOOLEAN -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "POWRPROF.dll"
#cfunc global SetSuspendState "SetSuspendState" int, int, int
; res = SetSuspendState(bHibernate, bForce, bWakeupEventsDisabled)
; bHibernate : BOOLEAN -> "int"
; bForce : BOOLEAN -> "int"
; bWakeupEventsDisabled : BOOLEAN -> "int"
; BOOLEAN SetSuspendState(BOOLEAN bHibernate, BOOLEAN bForce, BOOLEAN bWakeupEventsDisabled)
#uselib "POWRPROF.dll"
#cfunc global SetSuspendState "SetSuspendState" int, int, int
; res = SetSuspendState(bHibernate, bForce, bWakeupEventsDisabled)
; bHibernate : BOOLEAN -> "int"
; bForce : BOOLEAN -> "int"
; bWakeupEventsDisabled : BOOLEAN -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	powrprof = windows.NewLazySystemDLL("POWRPROF.dll")
	procSetSuspendState = powrprof.NewProc("SetSuspendState")
)

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

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

typedef SetSuspendStateNative = Uint8 Function(Uint8, Uint8, Uint8);
typedef SetSuspendStateDart = int Function(int, int, int);
final SetSuspendState = DynamicLibrary.open('POWRPROF.dll')
    .lookupFunction<SetSuspendStateNative, SetSuspendStateDart>('SetSuspendState');
// bHibernate : BOOLEAN -> Uint8
// bForce : BOOLEAN -> Uint8
// bWakeupEventsDisabled : BOOLEAN -> Uint8
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetSuspendState(
  bHibernate: ByteBool;   // BOOLEAN
  bForce: ByteBool;   // BOOLEAN
  bWakeupEventsDisabled: ByteBool   // BOOLEAN
): ByteBool; stdcall;
  external 'POWRPROF.dll' name 'SetSuspendState';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetSuspendState"
  c_SetSuspendState :: Word8 -> Word8 -> Word8 -> IO Word8
-- bHibernate : BOOLEAN -> Word8
-- bForce : BOOLEAN -> Word8
-- bWakeupEventsDisabled : BOOLEAN -> Word8
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setsuspendstate =
  foreign "SetSuspendState"
    (uint8_t @-> uint8_t @-> uint8_t @-> returning uint8_t)
(* bHibernate : BOOLEAN -> uint8_t *)
(* bForce : BOOLEAN -> uint8_t *)
(* bWakeupEventsDisabled : BOOLEAN -> uint8_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library powrprof (t "POWRPROF.dll"))
(cffi:use-foreign-library powrprof)

(cffi:defcfun ("SetSuspendState" set-suspend-state :convention :stdcall) :uint8
  (b-hibernate :uint8)   ; BOOLEAN
  (b-force :uint8)   ; BOOLEAN
  (b-wakeup-events-disabled :uint8))   ; BOOLEAN
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetSuspendState = Win32::API::More->new('POWRPROF',
    'BYTE SetSuspendState(BYTE bHibernate, BYTE bForce, BYTE bWakeupEventsDisabled)');
# my $ret = $SetSuspendState->Call($bHibernate, $bForce, $bWakeupEventsDisabled);
# bHibernate : BOOLEAN -> BYTE
# bForce : BOOLEAN -> BYTE
# bWakeupEventsDisabled : BOOLEAN -> BYTE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。