powerReadDescription 函数 (powrprof.h)
检索指定电源设置、子组或方案的说明。 如果 SchemeGuid 参数不为 NULL ,但 SubGroupOfPowerSettingsGuid 和 PowerSettingGuid 参数均为 NULL,则将返回电源方案的说明。 如果 SchemeGuid 和 SubGroupOfPowerSettingsGuid 参数不为 NULL ,并且 PowerSettingGuid 参数为 NULL,则将返回子组的说明。 如果 SchemeGuid、 SubGroupOfPowerSettingsGuid 和 PowerSettingGuid 参数不为 NULL,则将返回电源设置的说明。
语法
DWORD PowerReadDescription(
[in, optional] HKEY RootPowerKey,
[in, optional] const GUID *SchemeGuid,
[in, optional] const GUID *SubGroupOfPowerSettingsGuid,
[in, optional] const GUID *PowerSettingGuid,
[out, optional] PUCHAR Buffer,
[in, out] LPDWORD BufferSize
);
参数
[in, optional] RootPowerKey
此参数保留供将来使用,必须设置为 NULL。
[in, optional] SchemeGuid
电源方案的标识符。
[in, optional] SubGroupOfPowerSettingsGuid
电源设置的子组。 此参数可以是 WinNT.h 中定义的以下值之一。 使用 NO_SUBGROUP_GUID 引用默认电源方案。
[in, optional] PowerSettingGuid
正在使用的电源设置的标识符。
[out, optional] Buffer
指向接收说明的缓冲区的指针。 如果此参数为 NULL,则 BufferSize 参数接收所需的缓冲区大小。 返回的字符串都是宽 (Unicode) 字符串。
[in, out] BufferSize
指向变量的指针,该变量包含 Buffer 参数指向的 缓冲区 的大小。
如果 Buffer 参数为 NULL,则该函数返回ERROR_SUCCESS且变量接收所需的缓冲区大小。
如果指定的缓冲区大小不足以容纳请求的数据,则函数将返回 ERROR_MORE_DATA ,并且变量接收所需的缓冲区大小。
返回值
如果调用成功,则返回 ERROR_SUCCESS (零) ;如果调用失败,则返回非零值。 如果 BufferSize 参数指定的缓冲区大小太小,则函数将返回ERROR_SUCCESS并且 BufferSize 参数指向的 DWORD 将填充所需的缓冲区大小。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | Windows Vista [仅限桌面应用] |
最低受支持的服务器 | Windows Server 2008 [仅限桌面应用] |
目标平台 | Windows |
标头 | powrprof.h |
Library | PowrProf.lib |
DLL | PowrProf.dll |