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

DeletePwrScheme

関数
指定IDの電源スキームを削除する。
DLLPOWRPROF.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOLEAN DeletePwrScheme(
    DWORD uiID
);

パラメーター

名前方向説明
uiIDDWORDin削除する電源スキームのインデックス。

戻り値の型: BOOLEAN

公式ドキュメント

指定された電源スキームを削除します。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

アプリケーションは DeletePwrScheme を呼び出すことで、電源スキームを永続的に削除できます。現在アクティブな電源スキームを削除しようとすると、失敗し、最後のエラーが ERROR_ACCESS_DENIED に設定されます。

PowrProf.h の使用方法の詳細については、電源スキームを参照してください。

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

各言語での呼び出し定義

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

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

DeletePwrScheme = ctypes.windll.powrprof.DeletePwrScheme
DeletePwrScheme.restype = wintypes.BOOLEAN
DeletePwrScheme.argtypes = [
    wintypes.DWORD,  # uiID : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('POWRPROF.dll')
DeletePwrScheme = Fiddle::Function.new(
  lib['DeletePwrScheme'],
  [
    -Fiddle::TYPE_INT,  # uiID : DWORD
  ],
  Fiddle::TYPE_CHAR)
#[link(name = "powrprof")]
extern "system" {
    fn DeletePwrScheme(
        uiID: u32  // DWORD
    ) -> u8;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.U1)]
[DllImport("POWRPROF.dll", SetLastError = true)]
public static extern bool DeletePwrScheme(uint uiID);
"@
$api = Add-Type -MemberDefinition $sig -Name 'POWRPROF_DeletePwrScheme' -Namespace Win32 -PassThru
# $api::DeletePwrScheme(uiID)
#uselib "POWRPROF.dll"
#func global DeletePwrScheme "DeletePwrScheme" sptr
; DeletePwrScheme uiID   ; 戻り値は stat
; uiID : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "POWRPROF.dll"
#cfunc global DeletePwrScheme "DeletePwrScheme" int
; res = DeletePwrScheme(uiID)
; uiID : DWORD -> "int"
; BOOLEAN DeletePwrScheme(DWORD uiID)
#uselib "POWRPROF.dll"
#cfunc global DeletePwrScheme "DeletePwrScheme" int
; res = DeletePwrScheme(uiID)
; uiID : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	powrprof = windows.NewLazySystemDLL("POWRPROF.dll")
	procDeletePwrScheme = powrprof.NewProc("DeletePwrScheme")
)

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

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

typedef DeletePwrSchemeNative = Uint8 Function(Uint32);
typedef DeletePwrSchemeDart = int Function(int);
final DeletePwrScheme = DynamicLibrary.open('POWRPROF.dll')
    .lookupFunction<DeletePwrSchemeNative, DeletePwrSchemeDart>('DeletePwrScheme');
// uiID : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DeletePwrScheme(
  uiID: DWORD   // DWORD
): ByteBool; stdcall;
  external 'POWRPROF.dll' name 'DeletePwrScheme';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DeletePwrScheme"
  c_DeletePwrScheme :: Word32 -> IO Word8
-- uiID : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let deletepwrscheme =
  foreign "DeletePwrScheme"
    (uint32_t @-> returning uint8_t)
(* uiID : 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 ("DeletePwrScheme" delete-pwr-scheme :convention :stdcall) :uint8
  (ui-id :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DeletePwrScheme = Win32::API::More->new('POWRPROF',
    'BYTE DeletePwrScheme(DWORD uiID)');
# my $ret = $DeletePwrScheme->Call($uiID);
# uiID : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目