ホーム › System.Power › GetPwrDiskSpindownRange

GetPwrDiskSpindownRange

関数

ディスクのスピンダウン時間の最大値と最小値を取得する。

DLLPOWRPROF.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOLEAN GetPwrDiskSpindownRange(
    DWORD* puiMax,
    DWORD* puiMin
);

パラメーター

名前	型	方向	説明
puiMax	DWORD*	out	ディスクの最大スピンダウン時間(秒単位)。
puiMin	DWORD*	out	ディスクの最小スピンダウン時間(秒単位)。

戻り値の型: BOOLEAN

公式ドキュメント

ディスクのスピンダウン範囲を取得します。

戻り値

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

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

解説(Remarks)

Windows Vista 以降では、システムのハードディスクドライブの電源管理構成は GUID_DISK_SUBGROUP 電源設定サブグループを通じて制御されます。個々の設定を列挙するには、PowerEnumerate 関数を使用します。

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 GetPwrDiskSpindownRange(
    DWORD* puiMax,
    DWORD* puiMin
);

[return: MarshalAs(UnmanagedType.U1)]
[DllImport("POWRPROF.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetPwrDiskSpindownRange(
    out uint puiMax,   // DWORD* out
    out uint puiMin   // DWORD* out
);

<DllImport("POWRPROF.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetPwrDiskSpindownRange(
    <Out> ByRef puiMax As UInteger,   ' DWORD* out
    <Out> ByRef puiMin As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.U1)> Boolean
End Function

' puiMax : DWORD* out
' puiMin : DWORD* out
Declare PtrSafe Function GetPwrDiskSpindownRange Lib "powrprof" ( _
    ByRef puiMax As Long, _
    ByRef puiMin As Long) As Byte
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetPwrDiskSpindownRange = ctypes.windll.powrprof.GetPwrDiskSpindownRange
GetPwrDiskSpindownRange.restype = wintypes.BOOLEAN
GetPwrDiskSpindownRange.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # puiMax : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # puiMin : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('POWRPROF.dll')
GetPwrDiskSpindownRange = Fiddle::Function.new(
  lib['GetPwrDiskSpindownRange'],
  [
    Fiddle::TYPE_VOIDP,  # puiMax : DWORD* out
    Fiddle::TYPE_VOIDP,  # puiMin : DWORD* out
  ],
  Fiddle::TYPE_CHAR)

#[link(name = "powrprof")]
extern "system" {
    fn GetPwrDiskSpindownRange(
        puiMax: *mut u32,  // DWORD* out
        puiMin: *mut u32  // DWORD* out
    ) -> 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 GetPwrDiskSpindownRange(out uint puiMax, out uint puiMin);
"@
$api = Add-Type -MemberDefinition $sig -Name 'POWRPROF_GetPwrDiskSpindownRange' -Namespace Win32 -PassThru
# $api::GetPwrDiskSpindownRange(puiMax, puiMin)

#uselib "POWRPROF.dll"
#func global GetPwrDiskSpindownRange "GetPwrDiskSpindownRange" sptr, sptr
; GetPwrDiskSpindownRange varptr(puiMax), varptr(puiMin)   ; 戻り値は stat
; puiMax : DWORD* out -> "sptr"
; puiMin : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "POWRPROF.dll"
#cfunc global GetPwrDiskSpindownRange "GetPwrDiskSpindownRange" var, var
; res = GetPwrDiskSpindownRange(puiMax, puiMin)
; puiMax : DWORD* out -> "var"
; puiMin : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "POWRPROF.dll"
#cfunc global GetPwrDiskSpindownRange "GetPwrDiskSpindownRange" sptr, sptr
; res = GetPwrDiskSpindownRange(varptr(puiMax), varptr(puiMin))
; puiMax : DWORD* out -> "sptr"
; puiMin : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。