System.Gadget.SideShow.setFriendlyName method

[The Windows Gadget Platform/Sidebar is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions. ]

The display name for the SideShow gadget.

Syntax

iRetVal = System.Gadget.SideShow.setFriendlyName(
  strFriendlyName
)

Parameters

strFriendlyName [in]

String that specifies the display name.

Remarks

Verify that System.Gadget.SideShow.enabled returns true before using other System.Gadget.SideShow object members.

Examples

This image shows a SideShow emulator with a gadget and a friendly display name.

sideshow gadget friendly name image

The following example demonstrates how to set the display name for the SideShow gadget.

System.Gadget.SideShow.setFriendlyName("Stocks");

Requirements

Minimum supported client
Windows Vista [desktop apps only]
Minimum supported server
Windows Server 2008 [desktop apps only]
End of client support
Windows 7
End of server support
Windows Server 2008
IDL
Sidebar.idl
DLL
Sidebar.Exe (version 1.00 or later)

See also

System.Gadget.SideShow

Other Resources

Windows SideShow: MSDN

Windows SideShow: Windows Hardware Developer Central