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 |
程式庫 | PowrProf.lib |
Dll | PowrProf.dll |