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

PowerSettingAccessCheck

関数
指定電源設定へのアクセス権限を確認する。
DLLPOWRPROF.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

WIN32_ERROR PowerSettingAccessCheck(
    POWER_DATA_ACCESSOR AccessFlags,
    const GUID* PowerGuid   // optional
);

パラメーター

名前方向説明
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電源設定の識別子。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定された電源設定に対するグループポリシーのオーバーライドを照会します。

戻り値

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

戻り値/コード 説明
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 PowerSettingAccessCheck(
    POWER_DATA_ACCESSOR AccessFlags,
    const GUID* PowerGuid   // optional
);
[DllImport("POWRPROF.dll", ExactSpelling = true)]
static extern uint PowerSettingAccessCheck(
    int AccessFlags,   // POWER_DATA_ACCESSOR
    IntPtr PowerGuid   // GUID* optional
);
<DllImport("POWRPROF.dll", ExactSpelling:=True)>
Public Shared Function PowerSettingAccessCheck(
    AccessFlags As Integer,   ' POWER_DATA_ACCESSOR
    PowerGuid As IntPtr   ' GUID* optional
) As UInteger
End Function
' AccessFlags : POWER_DATA_ACCESSOR
' PowerGuid : GUID* optional
Declare PtrSafe Function PowerSettingAccessCheck Lib "powrprof" ( _
    ByVal AccessFlags As Long, _
    ByVal PowerGuid As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	powrprof = windows.NewLazySystemDLL("POWRPROF.dll")
	procPowerSettingAccessCheck = powrprof.NewProc("PowerSettingAccessCheck")
)

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

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

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

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

let powersettingaccesscheck =
  foreign "PowerSettingAccessCheck"
    (int32_t @-> (ptr void) @-> returning uint32_t)
(* AccessFlags : POWER_DATA_ACCESSOR -> int32_t *)
(* PowerGuid : 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 ("PowerSettingAccessCheck" power-setting-access-check :convention :stdcall) :uint32
  (access-flags :int32)   ; POWER_DATA_ACCESSOR
  (power-guid :pointer))   ; GUID* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PowerSettingAccessCheck = Win32::API::More->new('POWRPROF',
    'DWORD PowerSettingAccessCheck(int AccessFlags, LPVOID PowerGuid)');
# my $ret = $PowerSettingAccessCheck->Call($AccessFlags, $PowerGuid);
# AccessFlags : POWER_DATA_ACCESSOR -> int
# PowerGuid : GUID* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
使用する型