PowerWriteFriendlyName function
Sets the friendly name for the specified power setting, subgroup, or scheme. If the SchemeGuid parameter is not NULL but both the SubGroupOfPowerSettingsGuid and PowerSettingGuid parameters are NULL, the friendly name of the power scheme will be set. If the SchemeGuid and SubGroupOfPowerSettingsGuid parameters are not NULLand the PowerSettingGuid parameter is NULL, the friendly name of the subgroup will be set. If the SchemeGuid, SubGroupOfPowerSettingsGuid, and PowerSettingGuid parameters are not NULL, the friendly name of the power setting will be set.
Syntax
DWORD WINAPI PowerWriteFriendlyName( _In_opt_ HKEY RootPowerKey, _In_ const GUID *SchemeGuid, _In_opt_ const GUID *SubGroupOfPowerSettingsGuid, _In_opt_ const GUID *PowerSettingGuid, _In_ UCHAR *Buffer, _In_ DWORD BufferSize );
Parameters
- RootPowerKey [in, optional]
-
This parameter is reserved for future use and must be set to NULL.
- SchemeGuid [in]
-
The identifier of the power scheme.
- 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.
- PowerSettingGuid [in, optional]
-
The identifier of the power setting.
- Buffer [in]
-
The friendly name, in wide (Unicode) characters.
- BufferSize [in]
-
The size of the friendly name specified by the Buffer parameter, including the terminating NULL character.
Return value
Returns ERROR_SUCCESS (zero) if the call was successful, and a nonzero value if the call failed.
Remarks
Changes to the settings for the active power scheme do not take effect until you call the PowerSetActiveScheme function.
Requirements
|
Minimum supported client |
Windows Vista [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows Server 2008 [desktop apps only] |
|
Header |
|
|
Library |
|
|
DLL |
|
See also