nf-powrprof-powerwritedescription.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:powrprof.PowerWriteDescription	PowerWriteDescription function (powrprof.h)	Sets the description for the specified power setting, subgroup, or scheme.	GUID_BATTERY_SUBGROUP GUID_DISK_SUBGROUP GUID_PCIEXPRESS_SETTINGS_SUBGROUP GUID_PROCESSOR_SETTINGS_SUBGROUP GUID_SLEEP_SUBGROUP GUID_SYSTEM_BUTTON_SUBGROUP GUID_VIDEO_SUBGROUP NO_SUBGROUP_GUID PowerWriteDescription PowerWriteDescription function base.powerwritedescription powrprof/PowerWriteDescription	base\powerwritedescription.htm	base	42ee26ac-1a9c-4390-92e8-879b401168c7	12/05/2018	GUID_BATTERY_SUBGROUP, GUID_DISK_SUBGROUP, GUID_PCIEXPRESS_SETTINGS_SUBGROUP, GUID_PROCESSOR_SETTINGS_SUBGROUP, GUID_SLEEP_SUBGROUP, GUID_SYSTEM_BUTTON_SUBGROUP, GUID_VIDEO_SUBGROUP, NO_SUBGROUP_GUID, PowerWriteDescription, PowerWriteDescription function, base.powerwritedescription, powrprof/PowerWriteDescription	powrprof.h		Windows	Windows Vista [desktop apps only]	Windows Server 2008 [desktop apps only]										PowrProf.lib	PowrProf.dll		Windows			19H1	PowerWriteDescription powrprof/PowerWriteDescription	c++	APIRef kbSyntax	DllExport	PowrProf.dll	PowerWriteDescription

PowerWriteDescription function

-description

Sets the description for the specified power setting, subgroup, or scheme.

-parameters

-param RootPowerKey [in, optional]

This parameter is reserved for future use and must be set to NULL.

-param SchemeGuid [in]

The identifier of the power scheme.

-param SubGroupOfPowerSettingsGuid [in, optional]

The subgroup of power settings. This parameter can be one of the following values defined in WinNT.h. Use NO_SUBGROUP_GUID to refer to the default power scheme.

Value	Meaning
NO_SUBGROUP_GUID fea3413e-7e05-4911-9a71-700331f1c294	Settings in this subgroup are part of the default power scheme.
GUID_DISK_SUBGROUP 0012ee47-9041-4b5d-9b77-535fba8b1442	Settings in this subgroup control power management configuration of the system's hard disk drives.
GUID_SYSTEM_BUTTON_SUBGROUP 4f971e89-eebd-4455-a8de-9e59040e7347	Settings in this subgroup control configuration of the system power buttons.
GUID_PROCESSOR_SETTINGS_SUBGROUP 54533251-82be-4824-96c1-47b60b740d00	Settings in this subgroup control configuration of processor power management features.
GUID_VIDEO_SUBGROUP 7516b95f-f776-4464-8c53-06167f40cc99	Settings in this subgroup control configuration of the video power management features.
GUID_BATTERY_SUBGROUP e73a048d-bf27-4f12-9731-8b2076e8891f	Settings in this subgroup control battery alarm trip points and actions.
GUID_SLEEP_SUBGROUP 238C9FA8-0AAD-41ED-83F4-97BE242C8F20	Settings in this subgroup control system sleep settings.
GUID_PCIEXPRESS_SETTINGS_SUBGROUP 501a4d13-42af-4429-9fd1-a8218c268e20	Settings in this subgroup control PCI Express settings.

-param PowerSettingGuid [in, optional]

The identifier of the power setting.

-param Buffer [in]

The description, in wide (Unicode) characters.

-param BufferSize [in]

The size of the buffer pointed to by the Buffer parameter.

-returns

Returns ERROR_SUCCESS (zero) if the call was successful, and a nonzero value if the call failed.

-remarks

If the SchemeGuid parameter is not NULL but both the SubGroupOfPowerSettingsGuid and PowerSettingGuid parameters are NULL, the description of the power scheme will be set. If the SchemeGuid and SubGroupOfPowerSettingsGuid parameters are not NULL and the PowerSettingGuid parameter is NULL, the description of the subgroup will be set. If the SchemeGuid, SubGroupOfPowerSettingsGuid, and PowerSettingGuid parameters are not NULL, the description of the power setting will be set.

Changes to the settings for the active power scheme do not take effect until you call the PowerSetActiveScheme function.

-see-also

Power Management Functions