SideShowGadget.EndpointId Property

Article
06/12/2009

Gets or sets this gadget's Endpoint ID.

Namespace: Microsoft.SideShow
Assembly: Microsoft.SideShow (in microsoft.sideshow.dll)

Usage

Syntax

'Declaration
Protected Property EndpointId As Guid

protected Guid EndpointId { get; set; }

protected:
property Guid EndpointId {
    Guid get ();
    void set (Guid value);
}

/** @property */
protected Guid get_EndpointId ()

/** @property */
protected void set_EndpointId (Guid value)

protected function get EndpointId () : Guid

protected function set EndpointId (value : Guid)

Property Value

The gadget's Endpoint ID.

Example

This example code registers a SideShow gadget with Windows by using the ScfEndpointId field as a parameter.

private static void SampleRegister()
{
    // Set the gadget's GUID.
    Guid gadgetId = new Guid("{0530B726-F6D5-4a66-900E-3C7673316F3B}");
    // Register the gadget.
    GadgetRegistration.Register(
        false,                           // Register gadget for current user only
        gadgetId,                        // Guid for the registry subkey
        ScfSideShowGadget.ScfEndpointId, // Endpoints registry value
        "Example SideShow gadget",       // FriendlyName registry value
        null,                            // StartCommand registry value
        null,                            // Icon registry value, this gadget will use the generic gadget icon.
        false,                           // OnlineOnly registry value
        GadgetCachePolicies.KeepNewest,  // CachePolicy registry value
        null);                           // PropertyPage registry value
}

Remarks

This method will throw a InvalidOperationException if a set operation was requested and the EndPointId property has already been set.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Vista Home Premium, Windows Vista Business, Windows Vista Enterprise, Windows Vista Ultimate

Target Platforms