System.Gadget.SideShow.enabled 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. ]

Retrieves whether SideShow is supported.

Syntax

bRetVal = System.Gadget.SideShow.enabled()

Parameters

This method has no parameters.

Return value

Boolean that specifies the SideShow support.

Return value Description
true
SideShow is supported.
false
SideShow is not supported.

Remarks

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

Examples

The following example demonstrates how to determine whether SideShow is supported using enabled.

var sideshowEnabled = System.Gadget.SideShow.enabled();

if (sideshowEnabled) 
{
    // Do something.
}

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