ホーム › System.Power › PowerReadPossibleFriendlyName

PowerReadPossibleFriendlyName

関数

電源設定の選択可能な値のフレンドリ名を読み取る。

DLLPOWRPROF.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

WIN32_ERROR PowerReadPossibleFriendlyName(
    HKEY RootPowerKey,   // optional
    const GUID* SubGroupOfPowerSettingsGuid,   // optional
    const GUID* PowerSettingGuid,   // optional
    DWORD PossibleSettingIndex,
    BYTE* Buffer,   // optional
    DWORD* BufferSize
);

パラメーター

名前

型

方向

説明

RootPowerKey

HKEY

inoptional

このパラメーターは将来の使用のために予約されており、NULL に設定する必要があります。

SubGroupOfPowerSettingsGuid

GUID*

inoptional

電源設定のサブグループです。このパラメーターには、WinNT.h で定義されている次のいずれかの値を指定できます。既定の電源スキームを参照するには NO_SUBGROUP_GUID を使用します。

値	意味
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 の設定を制御します。

PowerSettingGuid

GUID*

inoptional

電源設定の識別子です。

PossibleSettingIndex

DWORD

選択肢に対する 0 から始まるインデックスです。

Buffer

BYTE*

outoptional

フレンドリ名を受け取るバッファへのポインターです。このパラメーターが NULL の場合、BufferSize パラメーターに必要なバッファサイズが格納されます。返される文字列はすべてワイド (Unicode) 文字列です。

BufferSize

DWORD*

inout

Buffer パラメーターが指すバッファのサイズを格納する変数へのポインターです。

Buffer パラメーターが NULL の場合、この関数は ERROR_SUCCESS を返し、変数に必要なバッファサイズが格納されます。

指定したバッファサイズが要求されたデータを保持するのに十分な大きさでない場合、この関数は ERROR_MORE_DATA を返し、変数に必要なバッファサイズが格納されます。

戻り値の型: WIN32_ERROR

公式ドキュメント

電源設定値の選択肢の 1 つに対応するフレンドリ名を取得します。

戻り値

呼び出しが成功した場合は ERROR_SUCCESS (ゼロ) を返し、失敗した場合は 0 以外の値を返します。BufferSize パラメーターで指定したバッファサイズが小さすぎる場合は ERROR_MORE_DATA が返され、BufferSize パラメーターが指す DWORD に必要なバッファサイズが格納されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 PowerReadPossibleFriendlyName(
    HKEY RootPowerKey,   // optional
    const GUID* SubGroupOfPowerSettingsGuid,   // optional
    const GUID* PowerSettingGuid,   // optional
    DWORD PossibleSettingIndex,
    BYTE* Buffer,   // optional
    DWORD* BufferSize
);

[DllImport("POWRPROF.dll", ExactSpelling = true)]
static extern uint PowerReadPossibleFriendlyName(
    IntPtr RootPowerKey,   // HKEY optional
    IntPtr SubGroupOfPowerSettingsGuid,   // GUID* optional
    IntPtr PowerSettingGuid,   // GUID* optional
    uint PossibleSettingIndex,   // DWORD
    IntPtr Buffer,   // BYTE* optional, out
    ref uint BufferSize   // DWORD* in/out
);

<DllImport("POWRPROF.dll", ExactSpelling:=True)>
Public Shared Function PowerReadPossibleFriendlyName(
    RootPowerKey As IntPtr,   ' HKEY optional
    SubGroupOfPowerSettingsGuid As IntPtr,   ' GUID* optional
    PowerSettingGuid As IntPtr,   ' GUID* optional
    PossibleSettingIndex As UInteger,   ' DWORD
    Buffer As IntPtr,   ' BYTE* optional, out
    ByRef BufferSize As UInteger   ' DWORD* in/out
) As UInteger
End Function

' RootPowerKey : HKEY optional
' SubGroupOfPowerSettingsGuid : GUID* optional
' PowerSettingGuid : GUID* optional
' PossibleSettingIndex : DWORD
' Buffer : BYTE* optional, out
' BufferSize : DWORD* in/out
Declare PtrSafe Function PowerReadPossibleFriendlyName Lib "powrprof" ( _
    ByVal RootPowerKey As LongPtr, _
    ByVal SubGroupOfPowerSettingsGuid As LongPtr, _
    ByVal PowerSettingGuid As LongPtr, _
    ByVal PossibleSettingIndex As Long, _
    ByVal Buffer As LongPtr, _
    ByRef BufferSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PowerReadPossibleFriendlyName = ctypes.windll.powrprof.PowerReadPossibleFriendlyName
PowerReadPossibleFriendlyName.restype = wintypes.DWORD
PowerReadPossibleFriendlyName.argtypes = [
    wintypes.HANDLE,  # RootPowerKey : HKEY optional
    ctypes.c_void_p,  # SubGroupOfPowerSettingsGuid : GUID* optional
    ctypes.c_void_p,  # PowerSettingGuid : GUID* optional
    wintypes.DWORD,  # PossibleSettingIndex : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # Buffer : BYTE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # BufferSize : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('POWRPROF.dll')
PowerReadPossibleFriendlyName = Fiddle::Function.new(
  lib['PowerReadPossibleFriendlyName'],
  [
    Fiddle::TYPE_VOIDP,  # RootPowerKey : HKEY optional
    Fiddle::TYPE_VOIDP,  # SubGroupOfPowerSettingsGuid : GUID* optional
    Fiddle::TYPE_VOIDP,  # PowerSettingGuid : GUID* optional
    -Fiddle::TYPE_INT,  # PossibleSettingIndex : DWORD
    Fiddle::TYPE_VOIDP,  # Buffer : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # BufferSize : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "powrprof")]
extern "system" {
    fn PowerReadPossibleFriendlyName(
        RootPowerKey: *mut core::ffi::c_void,  // HKEY optional
        SubGroupOfPowerSettingsGuid: *const GUID,  // GUID* optional
        PowerSettingGuid: *const GUID,  // GUID* optional
        PossibleSettingIndex: u32,  // DWORD
        Buffer: *mut u8,  // BYTE* optional, out
        BufferSize: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("POWRPROF.dll")]
public static extern uint PowerReadPossibleFriendlyName(IntPtr RootPowerKey, IntPtr SubGroupOfPowerSettingsGuid, IntPtr PowerSettingGuid, uint PossibleSettingIndex, IntPtr Buffer, ref uint BufferSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'POWRPROF_PowerReadPossibleFriendlyName' -Namespace Win32 -PassThru
# $api::PowerReadPossibleFriendlyName(RootPowerKey, SubGroupOfPowerSettingsGuid, PowerSettingGuid, PossibleSettingIndex, Buffer, BufferSize)

#uselib "POWRPROF.dll"
#func global PowerReadPossibleFriendlyName "PowerReadPossibleFriendlyName" sptr, sptr, sptr, sptr, sptr, sptr
; PowerReadPossibleFriendlyName RootPowerKey, varptr(SubGroupOfPowerSettingsGuid), varptr(PowerSettingGuid), PossibleSettingIndex, varptr(Buffer), varptr(BufferSize)   ; 戻り値は stat
; RootPowerKey : HKEY optional -> "sptr"
; SubGroupOfPowerSettingsGuid : GUID* optional -> "sptr"
; PowerSettingGuid : GUID* optional -> "sptr"
; PossibleSettingIndex : DWORD -> "sptr"
; Buffer : BYTE* optional, out -> "sptr"
; BufferSize : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "POWRPROF.dll"
#cfunc global PowerReadPossibleFriendlyName "PowerReadPossibleFriendlyName" sptr, var, var, int, var, var
; res = PowerReadPossibleFriendlyName(RootPowerKey, SubGroupOfPowerSettingsGuid, PowerSettingGuid, PossibleSettingIndex, Buffer, BufferSize)
; RootPowerKey : HKEY optional -> "sptr"
; SubGroupOfPowerSettingsGuid : GUID* optional -> "var"
; PowerSettingGuid : GUID* optional -> "var"
; PossibleSettingIndex : DWORD -> "int"
; Buffer : BYTE* optional, out -> "var"
; BufferSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "POWRPROF.dll"
#cfunc global PowerReadPossibleFriendlyName "PowerReadPossibleFriendlyName" sptr, sptr, sptr, int, sptr, sptr
; res = PowerReadPossibleFriendlyName(RootPowerKey, varptr(SubGroupOfPowerSettingsGuid), varptr(PowerSettingGuid), PossibleSettingIndex, varptr(Buffer), varptr(BufferSize))
; RootPowerKey : HKEY optional -> "sptr"
; SubGroupOfPowerSettingsGuid : GUID* optional -> "sptr"
; PowerSettingGuid : GUID* optional -> "sptr"
; PossibleSettingIndex : DWORD -> "int"
; Buffer : BYTE* optional, out -> "sptr"
; BufferSize : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; WIN32_ERROR PowerReadPossibleFriendlyName(HKEY RootPowerKey, GUID* SubGroupOfPowerSettingsGuid, GUID* PowerSettingGuid, DWORD PossibleSettingIndex, BYTE* Buffer, DWORD* BufferSize)
#uselib "POWRPROF.dll"
#cfunc global PowerReadPossibleFriendlyName "PowerReadPossibleFriendlyName" intptr, var, var, int, var, var
; res = PowerReadPossibleFriendlyName(RootPowerKey, SubGroupOfPowerSettingsGuid, PowerSettingGuid, PossibleSettingIndex, Buffer, BufferSize)
; RootPowerKey : HKEY optional -> "intptr"
; SubGroupOfPowerSettingsGuid : GUID* optional -> "var"
; PowerSettingGuid : GUID* optional -> "var"
; PossibleSettingIndex : DWORD -> "int"
; Buffer : BYTE* optional, out -> "var"
; BufferSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; WIN32_ERROR PowerReadPossibleFriendlyName(HKEY RootPowerKey, GUID* SubGroupOfPowerSettingsGuid, GUID* PowerSettingGuid, DWORD PossibleSettingIndex, BYTE* Buffer, DWORD* BufferSize)
#uselib "POWRPROF.dll"
#cfunc global PowerReadPossibleFriendlyName "PowerReadPossibleFriendlyName" intptr, intptr, intptr, int, intptr, intptr
; res = PowerReadPossibleFriendlyName(RootPowerKey, varptr(SubGroupOfPowerSettingsGuid), varptr(PowerSettingGuid), PossibleSettingIndex, varptr(Buffer), varptr(BufferSize))
; RootPowerKey : HKEY optional -> "intptr"
; SubGroupOfPowerSettingsGuid : GUID* optional -> "intptr"
; PowerSettingGuid : GUID* optional -> "intptr"
; PossibleSettingIndex : DWORD -> "int"
; Buffer : BYTE* optional, out -> "intptr"
; BufferSize : DWORD* in/out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	powrprof = windows.NewLazySystemDLL("POWRPROF.dll")
	procPowerReadPossibleFriendlyName = powrprof.NewProc("PowerReadPossibleFriendlyName")
)

// RootPowerKey (HKEY optional), SubGroupOfPowerSettingsGuid (GUID* optional), PowerSettingGuid (GUID* optional), PossibleSettingIndex (DWORD), Buffer (BYTE* optional, out), BufferSize (DWORD* in/out)
r1, _, err := procPowerReadPossibleFriendlyName.Call(
	uintptr(RootPowerKey),
	uintptr(SubGroupOfPowerSettingsGuid),
	uintptr(PowerSettingGuid),
	uintptr(PossibleSettingIndex),
	uintptr(Buffer),
	uintptr(BufferSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR

function PowerReadPossibleFriendlyName(
  RootPowerKey: THandle;   // HKEY optional
  SubGroupOfPowerSettingsGuid: PGUID;   // GUID* optional
  PowerSettingGuid: PGUID;   // GUID* optional
  PossibleSettingIndex: DWORD;   // DWORD
  Buffer: Pointer;   // BYTE* optional, out
  BufferSize: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'POWRPROF.dll' name 'PowerReadPossibleFriendlyName';

result := DllCall("POWRPROF\PowerReadPossibleFriendlyName"
    , "Ptr", RootPowerKey   ; HKEY optional
    , "Ptr", SubGroupOfPowerSettingsGuid   ; GUID* optional
    , "Ptr", PowerSettingGuid   ; GUID* optional
    , "UInt", PossibleSettingIndex   ; DWORD
    , "Ptr", Buffer   ; BYTE* optional, out
    , "Ptr", BufferSize   ; DWORD* in/out
    , "UInt")   ; return: WIN32_ERROR

●PowerReadPossibleFriendlyName(RootPowerKey, SubGroupOfPowerSettingsGuid, PowerSettingGuid, PossibleSettingIndex, Buffer, BufferSize) = DLL("POWRPROF.dll", "dword PowerReadPossibleFriendlyName(void*, void*, void*, dword, void*, void*)")
# 呼び出し: PowerReadPossibleFriendlyName(RootPowerKey, SubGroupOfPowerSettingsGuid, PowerSettingGuid, PossibleSettingIndex, Buffer, BufferSize)
# RootPowerKey : HKEY optional -> "void*"
# SubGroupOfPowerSettingsGuid : GUID* optional -> "void*"
# PowerSettingGuid : GUID* optional -> "void*"
# PossibleSettingIndex : DWORD -> "dword"
# Buffer : BYTE* optional, out -> "void*"
# BufferSize : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "powrprof" fn PowerReadPossibleFriendlyName(
    RootPowerKey: ?*anyopaque, // HKEY optional
    SubGroupOfPowerSettingsGuid: [*c]GUID, // GUID* optional
    PowerSettingGuid: [*c]GUID, // GUID* optional
    PossibleSettingIndex: u32, // DWORD
    Buffer: [*c]u8, // BYTE* optional, out
    BufferSize: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) u32;

proc PowerReadPossibleFriendlyName(
    RootPowerKey: pointer,  # HKEY optional
    SubGroupOfPowerSettingsGuid: ptr GUID,  # GUID* optional
    PowerSettingGuid: ptr GUID,  # GUID* optional
    PossibleSettingIndex: uint32,  # DWORD
    Buffer: ptr uint8,  # BYTE* optional, out
    BufferSize: ptr uint32  # DWORD* in/out
): uint32 {.importc: "PowerReadPossibleFriendlyName", stdcall, dynlib: "POWRPROF.dll".}

pragma(lib, "powrprof");
extern(Windows)
uint PowerReadPossibleFriendlyName(
    void* RootPowerKey,   // HKEY optional
    GUID* SubGroupOfPowerSettingsGuid,   // GUID* optional
    GUID* PowerSettingGuid,   // GUID* optional
    uint PossibleSettingIndex,   // DWORD
    ubyte* Buffer,   // BYTE* optional, out
    uint* BufferSize   // DWORD* in/out
);

ccall((:PowerReadPossibleFriendlyName, "POWRPROF.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{GUID}, Ptr{GUID}, UInt32, Ptr{UInt8}, Ptr{UInt32}),
      RootPowerKey, SubGroupOfPowerSettingsGuid, PowerSettingGuid, PossibleSettingIndex, Buffer, BufferSize)
# RootPowerKey : HKEY optional -> Ptr{Cvoid}
# SubGroupOfPowerSettingsGuid : GUID* optional -> Ptr{GUID}
# PowerSettingGuid : GUID* optional -> Ptr{GUID}
# PossibleSettingIndex : DWORD -> UInt32
# Buffer : BYTE* optional, out -> Ptr{UInt8}
# BufferSize : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
uint32_t PowerReadPossibleFriendlyName(
    void* RootPowerKey,
    void* SubGroupOfPowerSettingsGuid,
    void* PowerSettingGuid,
    uint32_t PossibleSettingIndex,
    uint8_t* Buffer,
    uint32_t* BufferSize);
]]
local powrprof = ffi.load("powrprof")
-- powrprof.PowerReadPossibleFriendlyName(RootPowerKey, SubGroupOfPowerSettingsGuid, PowerSettingGuid, PossibleSettingIndex, Buffer, BufferSize)
-- RootPowerKey : HKEY optional
-- SubGroupOfPowerSettingsGuid : GUID* optional
-- PowerSettingGuid : GUID* optional
-- PossibleSettingIndex : DWORD
-- Buffer : BYTE* optional, out
-- BufferSize : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('POWRPROF.dll');
const PowerReadPossibleFriendlyName = lib.func('__stdcall', 'PowerReadPossibleFriendlyName', 'uint32_t', ['void *', 'void *', 'void *', 'uint32_t', 'uint8_t *', 'uint32_t *']);
// PowerReadPossibleFriendlyName(RootPowerKey, SubGroupOfPowerSettingsGuid, PowerSettingGuid, PossibleSettingIndex, Buffer, BufferSize)
// RootPowerKey : HKEY optional -> 'void *'
// SubGroupOfPowerSettingsGuid : GUID* optional -> 'void *'
// PowerSettingGuid : GUID* optional -> 'void *'
// PossibleSettingIndex : DWORD -> 'uint32_t'
// Buffer : BYTE* optional, out -> 'uint8_t *'
// BufferSize : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("POWRPROF.dll", {
  PowerReadPossibleFriendlyName: { parameters: ["pointer", "pointer", "pointer", "u32", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.PowerReadPossibleFriendlyName(RootPowerKey, SubGroupOfPowerSettingsGuid, PowerSettingGuid, PossibleSettingIndex, Buffer, BufferSize)
// RootPowerKey : HKEY optional -> "pointer"
// SubGroupOfPowerSettingsGuid : GUID* optional -> "pointer"
// PowerSettingGuid : GUID* optional -> "pointer"
// PossibleSettingIndex : DWORD -> "u32"
// Buffer : BYTE* optional, out -> "pointer"
// BufferSize : DWORD* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
uint32_t PowerReadPossibleFriendlyName(
    void* RootPowerKey,
    void* SubGroupOfPowerSettingsGuid,
    void* PowerSettingGuid,
    uint32_t PossibleSettingIndex,
    uint8_t* Buffer,
    uint32_t* BufferSize);
C, "POWRPROF.dll");
// $ffi->PowerReadPossibleFriendlyName(RootPowerKey, SubGroupOfPowerSettingsGuid, PowerSettingGuid, PossibleSettingIndex, Buffer, BufferSize);
// RootPowerKey : HKEY optional
// SubGroupOfPowerSettingsGuid : GUID* optional
// PowerSettingGuid : GUID* optional
// PossibleSettingIndex : DWORD
// Buffer : BYTE* optional, out
// BufferSize : DWORD* in/out
// 構造体/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 PowerReadPossibleFriendlyName(
        Pointer RootPowerKey,   // HKEY optional
        Pointer SubGroupOfPowerSettingsGuid,   // GUID* optional
        Pointer PowerSettingGuid,   // GUID* optional
        int PossibleSettingIndex,   // DWORD
        byte[] Buffer,   // BYTE* optional, out
        IntByReference BufferSize   // DWORD* in/out
    );
}

@[Link("powrprof")]
lib LibPOWRPROF
  fun PowerReadPossibleFriendlyName = PowerReadPossibleFriendlyName(
    RootPowerKey : Void*,   # HKEY optional
    SubGroupOfPowerSettingsGuid : GUID*,   # GUID* optional
    PowerSettingGuid : GUID*,   # GUID* optional
    PossibleSettingIndex : UInt32,   # DWORD
    Buffer : UInt8*,   # BYTE* optional, out
    BufferSize : UInt32*   # DWORD* in/out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef PowerReadPossibleFriendlyNameNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, Uint32, Pointer<Uint8>, Pointer<Uint32>);
typedef PowerReadPossibleFriendlyNameDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, int, Pointer<Uint8>, Pointer<Uint32>);
final PowerReadPossibleFriendlyName = DynamicLibrary.open('POWRPROF.dll')
    .lookupFunction<PowerReadPossibleFriendlyNameNative, PowerReadPossibleFriendlyNameDart>('PowerReadPossibleFriendlyName');
// RootPowerKey : HKEY optional -> Pointer<Void>
// SubGroupOfPowerSettingsGuid : GUID* optional -> Pointer<Void>
// PowerSettingGuid : GUID* optional -> Pointer<Void>
// PossibleSettingIndex : DWORD -> Uint32
// Buffer : BYTE* optional, out -> Pointer<Uint8>
// BufferSize : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function PowerReadPossibleFriendlyName(
  RootPowerKey: THandle;   // HKEY optional
  SubGroupOfPowerSettingsGuid: PGUID;   // GUID* optional
  PowerSettingGuid: PGUID;   // GUID* optional
  PossibleSettingIndex: DWORD;   // DWORD
  Buffer: Pointer;   // BYTE* optional, out
  BufferSize: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'POWRPROF.dll' name 'PowerReadPossibleFriendlyName';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PowerReadPossibleFriendlyName"
  c_PowerReadPossibleFriendlyName :: Ptr () -> Ptr () -> Ptr () -> Word32 -> Ptr Word8 -> Ptr Word32 -> IO Word32
-- RootPowerKey : HKEY optional -> Ptr ()
-- SubGroupOfPowerSettingsGuid : GUID* optional -> Ptr ()
-- PowerSettingGuid : GUID* optional -> Ptr ()
-- PossibleSettingIndex : DWORD -> Word32
-- Buffer : BYTE* optional, out -> Ptr Word8
-- BufferSize : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let powerreadpossiblefriendlyname =
  foreign "PowerReadPossibleFriendlyName"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> uint32_t @-> (ptr uint8_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* RootPowerKey : HKEY optional -> (ptr void) *)
(* SubGroupOfPowerSettingsGuid : GUID* optional -> (ptr void) *)
(* PowerSettingGuid : GUID* optional -> (ptr void) *)
(* PossibleSettingIndex : DWORD -> uint32_t *)
(* Buffer : BYTE* optional, out -> (ptr uint8_t) *)
(* BufferSize : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library powrprof (t "POWRPROF.dll"))
(cffi:use-foreign-library powrprof)

(cffi:defcfun ("PowerReadPossibleFriendlyName" power-read-possible-friendly-name :convention :stdcall) :uint32
  (root-power-key :pointer)   ; HKEY optional
  (sub-group-of-power-settings-guid :pointer)   ; GUID* optional
  (power-setting-guid :pointer)   ; GUID* optional
  (possible-setting-index :uint32)   ; DWORD
  (buffer :pointer)   ; BYTE* optional, out
  (buffer-size :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $PowerReadPossibleFriendlyName = Win32::API::More->new('POWRPROF',
    'DWORD PowerReadPossibleFriendlyName(HANDLE RootPowerKey, LPVOID SubGroupOfPowerSettingsGuid, LPVOID PowerSettingGuid, DWORD PossibleSettingIndex, LPVOID Buffer, LPVOID BufferSize)');
# my $ret = $PowerReadPossibleFriendlyName->Call($RootPowerKey, $SubGroupOfPowerSettingsGuid, $PowerSettingGuid, $PossibleSettingIndex, $Buffer, $BufferSize);
# RootPowerKey : HKEY optional -> HANDLE
# SubGroupOfPowerSettingsGuid : GUID* optional -> LPVOID
# PowerSettingGuid : GUID* optional -> LPVOID
# PossibleSettingIndex : DWORD -> DWORD
# Buffer : BYTE* optional, out -> LPVOID
# BufferSize : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

PowerReadPossibleFriendlyName

シグネチャ

パラメーター

公式ドキュメント

戻り値

各言語での呼び出し定義

関連項目