Search
Module:
Directory

   Desktop Functions:

   Smart Device Functions:


Show Recent Changes
Subscribe (RSS)
Misc. Pages
Comments
FAQ
Helpful Tools
Playground
Suggested Reading
Website TODO List
Download Visual Studio Add-In

PowerWriteFriendlyName (powrprof)
 
.
Summary
Sets the friendly name for the specified power setting, subgroup, or scheme

C# Signature:

[DllImport("powrprof.dll", SetLastError=true, CharSet=CharSet.Unicode)]
    public static extern UInt32 PowerWriteFriendlyName(
            IntPtr RootPowerKey,
            ref Guid SchemeGuid,
            IntPtr SubGroupOfPowerSettingGuid,
            IntPtr PowerSettingGuid,
            String Buffer,
            UInt32 BufferSize);

VB Signature:

Declare Function PowerWriteFriendlyName Lib "powrprof.dll" (TODO) As TODO

User-Defined Types:

None.

Alternative Managed API:

Do you know one? Please contribute it!

Notes:

This function is only available from Vista.

Tips & Tricks:

Please add some!

Sample Code:

    static Boolean powerWriteFriendlyName(Guid powerPlanId, string name)
    {
        // The string must be null-terminated. A non null-terminated string will append junk characters on Windows Vista.
        name = name + char.MinValue;
        uint BufferSize = (uint)System.Text.ASCIIEncoding.Unicode.GetByteCount(name);

Please add some!

        uint set = NativeMethods.PowerWriteFriendlyName(IntPtr.Zero, ref powerPlanId, IntPtr.Zero, IntPtr.Zero, name, BufferSize);

        if (set == 0) //verify if the value has been set successfuly
        return true;
        else
        return false;
    }

Documentation

Please edit this page!

Do you have...

  • helpful tips or sample code to share for using this API in managed code?
  • corrections to the existing content?
  • variations of the signature you want to share?
  • additional languages you want to include?

Select "Edit This Page" on the right hand toolbar and edit it! Or add new pages containing supporting types needed for this API (structures, delegates, and more).

 
Access PInvoke.net directly from VS:
Terms of Use
Edit This Page
Find References
Show Printable Version
Revisions