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

PowerCreatePossibleSetting

関数
電源設定に選択可能な値の項目を作成する。
DLLPOWRPROF.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

WIN32_ERROR PowerCreatePossibleSetting(
    HKEY RootSystemPowerKey,   // optional
    const GUID* SubGroupOfPowerSettingsGuid,
    const GUID* PowerSettingGuid,
    DWORD PossibleSettingIndex
);

パラメーター

名前方向説明
RootSystemPowerKeyHKEYinoptionalこのパラメーターは将来の使用のために予約されており、NULL に設定する必要があります。
SubGroupOfPowerSettingsGuidGUID*in

電源設定のサブグループです。このパラメーターには、WinNT.h で定義されている次の値のいずれかを指定できます。

意味
NO_SUBGROUP_GUID
fea3413e-7e05-4911-9a71-700331f1c294
このサブグループの設定は、既定の電源スキームの一部です。
GUID_DISK_SUBGROUP
0012ee47-9041-4b5d-9b77-535fba8b1442
このサブグループの設定は、システムのハードディスクドライブの電源管理構成を制御します。
GUID_SYSTEM_BUTTON_SUBGROUP
4f971e89-eebd-4455-a8de-9e59040e7347
このサブグループの設定は、システムの電源ボタンの構成を制御します。
GUID_PROCESSOR_SETTINGS_SUBGROUP
54533251-82be-4824-96c1-47b60b740d00
このサブグループの設定は、プロセッサーの電源管理機能の構成を制御します。
GUID_VIDEO_SUBGROUP
7516b95f-f776-4464-8c53-06167f40cc99
このサブグループの設定は、ビデオの電源管理機能の構成を制御します。
GUID_BATTERY_SUBGROUP
e73a048d-bf27-4f12-9731-8b2076e8891f
このサブグループの設定は、バッテリーアラームのトリップポイントとアクションを制御します。
GUID_SLEEP_SUBGROUP
238C9FA8-0AAD-41ED-83F4-97BE242C8F20
このサブグループの設定は、システムのスリープ設定を制御します。
GUID_PCIEXPRESS_SETTINGS_SUBGROUP
501a4d13-42af-4429-9fd1-a8218c268e20
このサブグループの設定は、PCI Express の設定を制御します。
PowerSettingGuidGUID*in作成される電源設定の識別子です。
PossibleSettingIndexDWORDin作成される設定可能値の 0 から始まるインデックスです。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定された電源設定に対する設定可能値を作成します。

戻り値

呼び出しが成功した場合は ERROR_SUCCESS(ゼロ)を返し、呼び出しが失敗した場合は 0 以外の値を返します。

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

各言語での呼び出し定義

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

WIN32_ERROR PowerCreatePossibleSetting(
    HKEY RootSystemPowerKey,   // optional
    const GUID* SubGroupOfPowerSettingsGuid,
    const GUID* PowerSettingGuid,
    DWORD PossibleSettingIndex
);
[DllImport("POWRPROF.dll", ExactSpelling = true)]
static extern uint PowerCreatePossibleSetting(
    IntPtr RootSystemPowerKey,   // HKEY optional
    ref Guid SubGroupOfPowerSettingsGuid,   // GUID*
    ref Guid PowerSettingGuid,   // GUID*
    uint PossibleSettingIndex   // DWORD
);
<DllImport("POWRPROF.dll", ExactSpelling:=True)>
Public Shared Function PowerCreatePossibleSetting(
    RootSystemPowerKey As IntPtr,   ' HKEY optional
    ByRef SubGroupOfPowerSettingsGuid As Guid,   ' GUID*
    ByRef PowerSettingGuid As Guid,   ' GUID*
    PossibleSettingIndex As UInteger   ' DWORD
) As UInteger
End Function
' RootSystemPowerKey : HKEY optional
' SubGroupOfPowerSettingsGuid : GUID*
' PowerSettingGuid : GUID*
' PossibleSettingIndex : DWORD
Declare PtrSafe Function PowerCreatePossibleSetting Lib "powrprof" ( _
    ByVal RootSystemPowerKey As LongPtr, _
    ByVal SubGroupOfPowerSettingsGuid As LongPtr, _
    ByVal PowerSettingGuid As LongPtr, _
    ByVal PossibleSettingIndex As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PowerCreatePossibleSetting = ctypes.windll.powrprof.PowerCreatePossibleSetting
PowerCreatePossibleSetting.restype = wintypes.DWORD
PowerCreatePossibleSetting.argtypes = [
    wintypes.HANDLE,  # RootSystemPowerKey : HKEY optional
    ctypes.c_void_p,  # SubGroupOfPowerSettingsGuid : GUID*
    ctypes.c_void_p,  # PowerSettingGuid : GUID*
    wintypes.DWORD,  # PossibleSettingIndex : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('POWRPROF.dll')
PowerCreatePossibleSetting = Fiddle::Function.new(
  lib['PowerCreatePossibleSetting'],
  [
    Fiddle::TYPE_VOIDP,  # RootSystemPowerKey : HKEY optional
    Fiddle::TYPE_VOIDP,  # SubGroupOfPowerSettingsGuid : GUID*
    Fiddle::TYPE_VOIDP,  # PowerSettingGuid : GUID*
    -Fiddle::TYPE_INT,  # PossibleSettingIndex : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "powrprof")]
extern "system" {
    fn PowerCreatePossibleSetting(
        RootSystemPowerKey: *mut core::ffi::c_void,  // HKEY optional
        SubGroupOfPowerSettingsGuid: *const GUID,  // GUID*
        PowerSettingGuid: *const GUID,  // GUID*
        PossibleSettingIndex: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("POWRPROF.dll")]
public static extern uint PowerCreatePossibleSetting(IntPtr RootSystemPowerKey, ref Guid SubGroupOfPowerSettingsGuid, ref Guid PowerSettingGuid, uint PossibleSettingIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'POWRPROF_PowerCreatePossibleSetting' -Namespace Win32 -PassThru
# $api::PowerCreatePossibleSetting(RootSystemPowerKey, SubGroupOfPowerSettingsGuid, PowerSettingGuid, PossibleSettingIndex)
#uselib "POWRPROF.dll"
#func global PowerCreatePossibleSetting "PowerCreatePossibleSetting" sptr, sptr, sptr, sptr
; PowerCreatePossibleSetting RootSystemPowerKey, varptr(SubGroupOfPowerSettingsGuid), varptr(PowerSettingGuid), PossibleSettingIndex   ; 戻り値は stat
; RootSystemPowerKey : HKEY optional -> "sptr"
; SubGroupOfPowerSettingsGuid : GUID* -> "sptr"
; PowerSettingGuid : GUID* -> "sptr"
; PossibleSettingIndex : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "POWRPROF.dll"
#cfunc global PowerCreatePossibleSetting "PowerCreatePossibleSetting" sptr, var, var, int
; res = PowerCreatePossibleSetting(RootSystemPowerKey, SubGroupOfPowerSettingsGuid, PowerSettingGuid, PossibleSettingIndex)
; RootSystemPowerKey : HKEY optional -> "sptr"
; SubGroupOfPowerSettingsGuid : GUID* -> "var"
; PowerSettingGuid : GUID* -> "var"
; PossibleSettingIndex : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; WIN32_ERROR PowerCreatePossibleSetting(HKEY RootSystemPowerKey, GUID* SubGroupOfPowerSettingsGuid, GUID* PowerSettingGuid, DWORD PossibleSettingIndex)
#uselib "POWRPROF.dll"
#cfunc global PowerCreatePossibleSetting "PowerCreatePossibleSetting" intptr, var, var, int
; res = PowerCreatePossibleSetting(RootSystemPowerKey, SubGroupOfPowerSettingsGuid, PowerSettingGuid, PossibleSettingIndex)
; RootSystemPowerKey : HKEY optional -> "intptr"
; SubGroupOfPowerSettingsGuid : GUID* -> "var"
; PowerSettingGuid : GUID* -> "var"
; PossibleSettingIndex : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	powrprof = windows.NewLazySystemDLL("POWRPROF.dll")
	procPowerCreatePossibleSetting = powrprof.NewProc("PowerCreatePossibleSetting")
)

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

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

typedef PowerCreatePossibleSettingNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, Uint32);
typedef PowerCreatePossibleSettingDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, int);
final PowerCreatePossibleSetting = DynamicLibrary.open('POWRPROF.dll')
    .lookupFunction<PowerCreatePossibleSettingNative, PowerCreatePossibleSettingDart>('PowerCreatePossibleSetting');
// RootSystemPowerKey : HKEY optional -> Pointer<Void>
// SubGroupOfPowerSettingsGuid : GUID* -> Pointer<Void>
// PowerSettingGuid : GUID* -> Pointer<Void>
// PossibleSettingIndex : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PowerCreatePossibleSetting(
  RootSystemPowerKey: THandle;   // HKEY optional
  SubGroupOfPowerSettingsGuid: PGUID;   // GUID*
  PowerSettingGuid: PGUID;   // GUID*
  PossibleSettingIndex: DWORD   // DWORD
): DWORD; stdcall;
  external 'POWRPROF.dll' name 'PowerCreatePossibleSetting';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PowerCreatePossibleSetting"
  c_PowerCreatePossibleSetting :: Ptr () -> Ptr () -> Ptr () -> Word32 -> IO Word32
-- RootSystemPowerKey : HKEY optional -> Ptr ()
-- SubGroupOfPowerSettingsGuid : GUID* -> Ptr ()
-- PowerSettingGuid : GUID* -> Ptr ()
-- PossibleSettingIndex : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let powercreatepossiblesetting =
  foreign "PowerCreatePossibleSetting"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> uint32_t @-> returning uint32_t)
(* RootSystemPowerKey : HKEY optional -> (ptr void) *)
(* SubGroupOfPowerSettingsGuid : GUID* -> (ptr void) *)
(* PowerSettingGuid : GUID* -> (ptr void) *)
(* PossibleSettingIndex : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library powrprof (t "POWRPROF.dll"))
(cffi:use-foreign-library powrprof)

(cffi:defcfun ("PowerCreatePossibleSetting" power-create-possible-setting :convention :stdcall) :uint32
  (root-system-power-key :pointer)   ; HKEY optional
  (sub-group-of-power-settings-guid :pointer)   ; GUID*
  (power-setting-guid :pointer)   ; GUID*
  (possible-setting-index :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PowerCreatePossibleSetting = Win32::API::More->new('POWRPROF',
    'DWORD PowerCreatePossibleSetting(HANDLE RootSystemPowerKey, LPVOID SubGroupOfPowerSettingsGuid, LPVOID PowerSettingGuid, DWORD PossibleSettingIndex)');
# my $ret = $PowerCreatePossibleSetting->Call($RootSystemPowerKey, $SubGroupOfPowerSettingsGuid, $PowerSettingGuid, $PossibleSettingIndex);
# RootSystemPowerKey : HKEY optional -> HANDLE
# SubGroupOfPowerSettingsGuid : GUID* -> LPVOID
# PowerSettingGuid : GUID* -> LPVOID
# PossibleSettingIndex : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型