SnapInInstaller Class

Article
01/20/2017

Utilizes reflection to search for the snap-ins that are defined within the currently loaded assembly. The resulting metadata is then used to populate or remove register entries that correspond to each snap-in. For each assemblies in which snap-ins are defined, a class that is derived from the SnapInInstaller class must exist with the RunInstallerAttribute set to true. Unless additional assembly registration needs to be performed, this derived class declaration does not need to override any of the SnapInInstaller virtual methods. The derived class provides an entry point for tools such as InstallUtil.exe to execute the framework installer code. The SnapInInstaller class is the base class for snap-in registration.

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

Inheritance Hierarchy

System.Object
System.MarshalByRefObject
System.ComponentModel.Component
System.Configuration.Install.Installer
Microsoft.ManagementConsole.SnapInInstaller

Syntax

public class SnapInInstaller : Installer

public ref class SnapInInstaller : Installer

type SnapInInstaller = 
    class
        inherit Installer
    end

Public Class SnapInInstaller
    Inherits Installer

Constructors

	Name	Description
	SnapInInstaller()	Initializes a new instance of the SnapInInstaller class.

Properties

	Name	Description
	CanRaiseEvents	(Inherited from Component.)
	Container	(Inherited from Component.)
	Context	(Inherited from Installer.)
	DesignMode	(Inherited from Component.)
	Events	(Inherited from Component.)
	HelpText	(Inherited from Installer.)
	Installers	(Inherited from Installer.)
	Parent	(Inherited from Installer.)
	Site	(Inherited from Component.)

Methods

	Name	Description
	Commit(IDictionary)	(Inherited from Installer.)
	CreateObjRef(Type)	(Inherited from MarshalByRefObject.)
	Dispose()	(Inherited from Component.)
	Dispose(Boolean)	(Inherited from Component.)
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Component.)
	GetHashCode()	(Inherited from Object.)
	GetLifetimeService()	(Inherited from MarshalByRefObject.)
	GetService(Type)	(Inherited from Component.)
	GetType()	(Inherited from Object.)
	InitializeLifetimeService()	(Inherited from MarshalByRefObject.)
	Install(IDictionary)	Writes settings into the registry. This method overrides the virtual Install method for Installer class. For each snap-in that is defined in the loaded assembly, reflection is used to get registration information such as their node types, their snap-in identities, and other information. These settings are then written to the registry. If a rollback is required, previous settings are stored in the supplied IDictionary value. (Overrides Installer.Install(IDictionary).)
	MemberwiseClone()	(Inherited from Object.)
	MemberwiseClone(Boolean)	(Inherited from MarshalByRefObject.)
	OnAfterInstall(IDictionary)	(Inherited from Installer.)
	OnAfterRollback(IDictionary)	(Inherited from Installer.)
	OnAfterUninstall(IDictionary)	(Inherited from Installer.)
	OnBeforeInstall(IDictionary)	(Inherited from Installer.)
	OnBeforeRollback(IDictionary)	(Inherited from Installer.)
	OnBeforeUninstall(IDictionary)	(Inherited from Installer.)
	OnCommitted(IDictionary)	(Inherited from Installer.)
	OnCommitting(IDictionary)	(Inherited from Installer.)
	Rollback(IDictionary)	This method uses any saved registry settings in the supplied dictionary and attempts to reapply them. This method overrides the virtual Rollback method for the Installer class. (Overrides Installer.Rollback(IDictionary).)
	ToString()	(Inherited from Component.)
	Uninstall(IDictionary)	Removes settings from the registry. This method overrides the virtual Uninstall method for the Installer class. For each snap-in that is defined in the loaded assembly, reflection is used to get registration information such as their node types, their identities, and other information. These settings are then removed from the registry as part of the uninstall. (Overrides Installer.Uninstall(IDictionary).)

Events

	Name	Description
	AfterInstall	(Inherited from Installer.)
	AfterRollback	(Inherited from Installer.)
	AfterUninstall	(Inherited from Installer.)
	BeforeInstall	(Inherited from Installer.)
	BeforeRollback	(Inherited from Installer.)
	BeforeUninstall	(Inherited from Installer.)
	Committed	(Inherited from Installer.)
	Committing	(Inherited from Installer.)
	Disposed	(Inherited from Component.)

Remarks

The current implementation of the SnapInInstaller class assumes and enforces the fact that an assembly contains at most one snap-in per assembly. Furthermore, it is assumed that all of the nodes for that snap-in that can be registered are also defined within the assembly. Any nodes that are defined within an assembly are assumed to be associated with the snap-in that is defined within that assembly.

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.