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

PowerIsSettingRangeDefined

関数
指定の電源設定に値の範囲が定義されているか判定する。
DLLPOWRPROF.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

BOOLEAN PowerIsSettingRangeDefined(
    const GUID* SubKeyGuid,   // optional
    const GUID* SettingGuid   // optional
);

パラメーター

名前方向説明
SubKeyGuidGUID*inoptional検索対象のサブキーの識別子。
SettingGuidGUID*inoptional照会する電源設定の識別子。

戻り値の型: BOOLEAN

公式ドキュメント

指定された電源設定が、取り得る値の範囲を表すかどうかを照会します。

戻り値

SubKeyGuid で指定されたレジストリキーが単一の電源設定を表す場合は TRUE。

SubKeyGuid で指定されたレジストリキーが範囲を表す場合、この関数は FALSE を返します。

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

各言語での呼び出し定義

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

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

PowerIsSettingRangeDefined = ctypes.windll.powrprof.PowerIsSettingRangeDefined
PowerIsSettingRangeDefined.restype = wintypes.BOOLEAN
PowerIsSettingRangeDefined.argtypes = [
    ctypes.c_void_p,  # SubKeyGuid : GUID* optional
    ctypes.c_void_p,  # SettingGuid : GUID* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('POWRPROF.dll')
PowerIsSettingRangeDefined = Fiddle::Function.new(
  lib['PowerIsSettingRangeDefined'],
  [
    Fiddle::TYPE_VOIDP,  # SubKeyGuid : GUID* optional
    Fiddle::TYPE_VOIDP,  # SettingGuid : GUID* optional
  ],
  Fiddle::TYPE_CHAR)
#[link(name = "powrprof")]
extern "system" {
    fn PowerIsSettingRangeDefined(
        SubKeyGuid: *const GUID,  // GUID* optional
        SettingGuid: *const GUID  // GUID* optional
    ) -> u8;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.U1)]
[DllImport("POWRPROF.dll")]
public static extern bool PowerIsSettingRangeDefined(IntPtr SubKeyGuid, IntPtr SettingGuid);
"@
$api = Add-Type -MemberDefinition $sig -Name 'POWRPROF_PowerIsSettingRangeDefined' -Namespace Win32 -PassThru
# $api::PowerIsSettingRangeDefined(SubKeyGuid, SettingGuid)
#uselib "POWRPROF.dll"
#func global PowerIsSettingRangeDefined "PowerIsSettingRangeDefined" sptr, sptr
; PowerIsSettingRangeDefined varptr(SubKeyGuid), varptr(SettingGuid)   ; 戻り値は stat
; SubKeyGuid : GUID* optional -> "sptr"
; SettingGuid : GUID* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "POWRPROF.dll"
#cfunc global PowerIsSettingRangeDefined "PowerIsSettingRangeDefined" var, var
; res = PowerIsSettingRangeDefined(SubKeyGuid, SettingGuid)
; SubKeyGuid : GUID* optional -> "var"
; SettingGuid : GUID* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOLEAN PowerIsSettingRangeDefined(GUID* SubKeyGuid, GUID* SettingGuid)
#uselib "POWRPROF.dll"
#cfunc global PowerIsSettingRangeDefined "PowerIsSettingRangeDefined" var, var
; res = PowerIsSettingRangeDefined(SubKeyGuid, SettingGuid)
; SubKeyGuid : GUID* optional -> "var"
; SettingGuid : GUID* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	powrprof = windows.NewLazySystemDLL("POWRPROF.dll")
	procPowerIsSettingRangeDefined = powrprof.NewProc("PowerIsSettingRangeDefined")
)

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

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

typedef PowerIsSettingRangeDefinedNative = Uint8 Function(Pointer<Void>, Pointer<Void>);
typedef PowerIsSettingRangeDefinedDart = int Function(Pointer<Void>, Pointer<Void>);
final PowerIsSettingRangeDefined = DynamicLibrary.open('POWRPROF.dll')
    .lookupFunction<PowerIsSettingRangeDefinedNative, PowerIsSettingRangeDefinedDart>('PowerIsSettingRangeDefined');
// SubKeyGuid : GUID* optional -> Pointer<Void>
// SettingGuid : GUID* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PowerIsSettingRangeDefined(
  SubKeyGuid: PGUID;   // GUID* optional
  SettingGuid: PGUID   // GUID* optional
): ByteBool; stdcall;
  external 'POWRPROF.dll' name 'PowerIsSettingRangeDefined';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PowerIsSettingRangeDefined"
  c_PowerIsSettingRangeDefined :: Ptr () -> Ptr () -> IO Word8
-- SubKeyGuid : GUID* optional -> Ptr ()
-- SettingGuid : GUID* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("PowerIsSettingRangeDefined" power-is-setting-range-defined :convention :stdcall) :uint8
  (sub-key-guid :pointer)   ; GUID* optional
  (setting-guid :pointer))   ; GUID* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PowerIsSettingRangeDefined = Win32::API::More->new('POWRPROF',
    'BYTE PowerIsSettingRangeDefined(LPVOID SubKeyGuid, LPVOID SettingGuid)');
# my $ret = $PowerIsSettingRangeDefined->Call($SubKeyGuid, $SettingGuid);
# SubKeyGuid : GUID* optional -> LPVOID
# SettingGuid : GUID* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。