SnapInBase Class

Article
01/20/2017

Provides an implementation of functionality that is common to both stand-alone snap-ins and extension snap-ins. It provides synchronization services for snap-ins.

Namespace: Microsoft.ManagementConsole
Assembly: Microsoft.ManagementConsole (in Microsoft.ManagementConsole.dll)

Inheritance Hierarchy

System.Object
Microsoft.ManagementConsole.SnapInBase
Microsoft.ManagementConsole.Advanced.PropertySheetExtension
Microsoft.ManagementConsole.NamespaceSnapInBase

Syntax

public abstract class SnapInBase : ISynchronizeInvoke

public ref class SnapInBase abstract : ISynchronizeInvoke

[<AbstractClass>]
type SnapInBase = 
    class
        interface ISynchronizeInvoke
    end

Public MustInherit Class SnapInBase
    Implements ISynchronizeInvoke

Properties

	Name	Description
	Id	Gets the identifier for the instance of the snap-in. The identifier is unique across snap-in instances within a console.
	InvokeRequired	Gets a value that indicates whether the caller must call the Invoke or the BeginInvoke methods when calling a method on a snap-in component. This distinction is necessary when the caller is on a different thread than the thread that the snap-in was created on.
	Tag	Gets or sets an object that contains application-specific information that is associated with the snap-in.

Methods

	Name	Description
	BeginInvoke(Delegate)	Executes the specified delegate asynchronously on the thread that the snap-in was created on.
	BeginInvoke(Delegate, Object[])	Executes the specified delegate with its specified arguments on the main thread that the snap-in was created on.
	EndInvoke(IAsyncResult)	Waits until the process that was started by calling BeginInvoke completes. This method then retrieves the return value of the asynchronous operation identified by the result parameter.
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	Invoke(Delegate)	Executes the delegate on the main thread that the snap-in executes on.
	Invoke(Delegate, Object[])	Executes the delegate on the main thread that the snap-in executes on.
	MemberwiseClone()	(Inherited from Object.)
	OnInitialize()	Called when a snap-in is initialized. It allows derived classes to provide additional initialization.
	OnShutdown(AsyncStatus)	Called when the snap-in is shutting down. Once this call returns, actions which modify the console, such as adding nodes, or modifying view descriptions, are not honored.
	RegisterCurrentThreadForUI()	Called on a background thread to register it as a candidate for showing pop-up UI.
	ShowHelpTopic(String)	Displays a help topic.
	ToString()	(Inherited from Object.)
	UnregisterCurrentThreadForUI()	Called on a background thread to unregister it as a candidate for showing pop-up UI.

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.

Share via