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

PowerSettingAccessCheckEx

関数
指定電源設定へのアクセス権限を拡張オプションで確認する。
DLLPOWRPROF.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

WIN32_ERROR PowerSettingAccessCheckEx(
    POWER_DATA_ACCESSOR AccessFlags,
    const GUID* PowerGuid,   // optional
    REG_SAM_FLAGS AccessType
);

パラメーター

名前方向説明
AccessFlagsPOWER_DATA_ACCESSORin

グループポリシーのオーバーライドを確認するアクセスの種類。

意味
ACCESS_AC_POWER_SETTING_INDEX
0 (0x0)
AC 電源設定のオーバーライドを確認します。
ACCESS_DC_POWER_SETTING_INDEX
1 (0x1)
DC 電源設定のオーバーライドを確認します。
ACCESS_SCHEME
16 (0x10)
特定の電源スキームに対する制限を確認します。
ACCESS_ACTIVE_SCHEME
19 (0x13)
アクティブな電源スキームに対する制限を確認します。
ACCESS_CREATE_SCHEME
20 (0x14)
電源スキームの作成または復元に対する制限を確認します。
PowerGuidGUID*inoptional電源設定の識別子。
AccessTypeREG_SAM_FLAGSin

設定に対するセキュリティアクセスの種類。詳細については、レジストリキーのセキュリティとアクセス権を参照してください。

このパラメーターには、次のいずれかの値を指定できます。

意味
KEY_READ
STANDARD_RIGHTS_READKEY_QUERY_VALUEKEY_ENUMERATE_SUB_KEYS、および KEY_NOTIFY の各値を組み合わせたものです。
KEY_WRITE
STANDARD_RIGHTS_WRITEKEY_SET_VALUE、および KEY_CREATE_SUB_KEY の各アクセス権を組み合わせたものです。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定した電源設定に対するグループポリシーのオーバーライドを照会し、その設定に要求するアクセスを指定します。

戻り値

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

戻り値/値 説明
ERROR_SUCCESS
0 (0x0)
指定された電源設定は、現在グループポリシーによってオーバーライドされていません。
ERROR_ACCESS_DISABLED_BY_POLICY
1260 (0x4EC)
このプログラムはグループポリシーによってブロックされています。詳細については、システム管理者に問い合わせてください。
ERROR_INSTALL_REMOTE_DISALLOWED
1640 (0x668)
電源設定にリモートでアクセスできるのは管理者のみです。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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 PowerSettingAccessCheckEx(
    POWER_DATA_ACCESSOR AccessFlags,
    const GUID* PowerGuid,   // optional
    REG_SAM_FLAGS AccessType
);
[DllImport("POWRPROF.dll", ExactSpelling = true)]
static extern uint PowerSettingAccessCheckEx(
    int AccessFlags,   // POWER_DATA_ACCESSOR
    IntPtr PowerGuid,   // GUID* optional
    uint AccessType   // REG_SAM_FLAGS
);
<DllImport("POWRPROF.dll", ExactSpelling:=True)>
Public Shared Function PowerSettingAccessCheckEx(
    AccessFlags As Integer,   ' POWER_DATA_ACCESSOR
    PowerGuid As IntPtr,   ' GUID* optional
    AccessType As UInteger   ' REG_SAM_FLAGS
) As UInteger
End Function
' AccessFlags : POWER_DATA_ACCESSOR
' PowerGuid : GUID* optional
' AccessType : REG_SAM_FLAGS
Declare PtrSafe Function PowerSettingAccessCheckEx Lib "powrprof" ( _
    ByVal AccessFlags As Long, _
    ByVal PowerGuid As LongPtr, _
    ByVal AccessType As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PowerSettingAccessCheckEx = ctypes.windll.powrprof.PowerSettingAccessCheckEx
PowerSettingAccessCheckEx.restype = wintypes.DWORD
PowerSettingAccessCheckEx.argtypes = [
    ctypes.c_int,  # AccessFlags : POWER_DATA_ACCESSOR
    ctypes.c_void_p,  # PowerGuid : GUID* optional
    wintypes.DWORD,  # AccessType : REG_SAM_FLAGS
]
require 'fiddle'
require 'fiddle/import'

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

var (
	powrprof = windows.NewLazySystemDLL("POWRPROF.dll")
	procPowerSettingAccessCheckEx = powrprof.NewProc("PowerSettingAccessCheckEx")
)

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

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

typedef PowerSettingAccessCheckExNative = Uint32 Function(Int32, Pointer<Void>, Uint32);
typedef PowerSettingAccessCheckExDart = int Function(int, Pointer<Void>, int);
final PowerSettingAccessCheckEx = DynamicLibrary.open('POWRPROF.dll')
    .lookupFunction<PowerSettingAccessCheckExNative, PowerSettingAccessCheckExDart>('PowerSettingAccessCheckEx');
// AccessFlags : POWER_DATA_ACCESSOR -> Int32
// PowerGuid : GUID* optional -> Pointer<Void>
// AccessType : REG_SAM_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PowerSettingAccessCheckEx(
  AccessFlags: Integer;   // POWER_DATA_ACCESSOR
  PowerGuid: PGUID;   // GUID* optional
  AccessType: DWORD   // REG_SAM_FLAGS
): DWORD; stdcall;
  external 'POWRPROF.dll' name 'PowerSettingAccessCheckEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PowerSettingAccessCheckEx"
  c_PowerSettingAccessCheckEx :: Int32 -> Ptr () -> Word32 -> IO Word32
-- AccessFlags : POWER_DATA_ACCESSOR -> Int32
-- PowerGuid : GUID* optional -> Ptr ()
-- AccessType : REG_SAM_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let powersettingaccesscheckex =
  foreign "PowerSettingAccessCheckEx"
    (int32_t @-> (ptr void) @-> uint32_t @-> returning uint32_t)
(* AccessFlags : POWER_DATA_ACCESSOR -> int32_t *)
(* PowerGuid : GUID* optional -> (ptr void) *)
(* AccessType : REG_SAM_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library powrprof (t "POWRPROF.dll"))
(cffi:use-foreign-library powrprof)

(cffi:defcfun ("PowerSettingAccessCheckEx" power-setting-access-check-ex :convention :stdcall) :uint32
  (access-flags :int32)   ; POWER_DATA_ACCESSOR
  (power-guid :pointer)   ; GUID* optional
  (access-type :uint32))   ; REG_SAM_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PowerSettingAccessCheckEx = Win32::API::More->new('POWRPROF',
    'DWORD PowerSettingAccessCheckEx(int AccessFlags, LPVOID PowerGuid, DWORD AccessType)');
# my $ret = $PowerSettingAccessCheckEx->Call($AccessFlags, $PowerGuid, $AccessType);
# AccessFlags : POWER_DATA_ACCESSOR -> int
# PowerGuid : GUID* optional -> LPVOID
# AccessType : REG_SAM_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
使用する型