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

IsPwrSuspendAllowed

関数
システムのサスペンドが許可されているか判定する。
DLLPOWRPROF.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

BOOLEAN IsPwrSuspendAllowed(void);

パラメーターなし。戻り値: BOOLEAN

公式ドキュメント

コンピューターがスリープ状態をサポートしているかどうかを判定します。

戻り値

コンピューターがスリープ状態(S1、S2、S3)をサポートしている場合、この関数は TRUE を返します。それ以外の場合、この関数は FALSE を返します。

解説(Remarks)

この情報は CallNtPowerInformation 関数からも取得できます。 SYSTEM_POWER_CAPABILITIES 構造体の SystemS1SystemS2SystemS3 メンバーを確認してください。

PowrProf.h の使用方法の詳細については、Power Schemes を参照してください。

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

各言語での呼び出し定義

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

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

IsPwrSuspendAllowed = ctypes.windll.powrprof.IsPwrSuspendAllowed
IsPwrSuspendAllowed.restype = wintypes.BOOLEAN
IsPwrSuspendAllowed.argtypes = []
require 'fiddle'
require 'fiddle/import'

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

var (
	powrprof = windows.NewLazySystemDLL("POWRPROF.dll")
	procIsPwrSuspendAllowed = powrprof.NewProc("IsPwrSuspendAllowed")
)

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

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

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

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

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

(cffi:defcfun ("IsPwrSuspendAllowed" is-pwr-suspend-allowed :convention :stdcall) :uint8)
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $IsPwrSuspendAllowed = Win32::API::More->new('POWRPROF',
    'BYTE IsPwrSuspendAllowed()');
# my $ret = $IsPwrSuspendAllowed->Call();
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目