PerformanceCounterInstaller Class
TOC
Collapse the table of content
Expand the table of content

PerformanceCounterInstaller Class

 

Specifies an installer for the PerformanceCounter component.

Namespace:   System.Diagnostics
Assembly:  System.Configuration.Install (in System.Configuration.Install.dll)

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Configuration.Install.Installer
        System.Configuration.Install.ComponentInstaller
          System.Diagnostics.PerformanceCounterInstaller

public class PerformanceCounterInstaller : ComponentInstaller

NameDescription
System_CAPS_pubmethodPerformanceCounterInstaller()

Initializes a new instance of the PerformanceCounterInstaller class.

NameDescription
System_CAPS_protpropertyCanRaiseEvents

Gets a value indicating whether the component can raise an event.(Inherited from Component.)

System_CAPS_pubpropertyCategoryHelp

Gets or sets the descriptive message for the performance counter.

System_CAPS_pubpropertyCategoryName

Gets or sets the performance category name for the performance counter.

System_CAPS_pubpropertyCategoryType

Gets or sets the performance counter category type.

System_CAPS_pubpropertyContainer

Gets the IContainer that contains the Component.(Inherited from Component.)

System_CAPS_pubpropertyContext

Gets or sets information about the current installation.(Inherited from Installer.)

System_CAPS_pubpropertyCounters

Gets a collection of data that pertains to the counters to install.

System_CAPS_protpropertyDesignMode

Gets a value that indicates whether the Component is currently in design mode.(Inherited from Component.)

System_CAPS_protpropertyEvents

Gets the list of event handlers that are attached to this Component.(Inherited from Component.)

System_CAPS_pubpropertyHelpText

Gets the help text for all the installers in the installer collection.(Inherited from Installer.)

System_CAPS_pubpropertyInstallers

Gets the collection of installers that this installer contains.(Inherited from Installer.)

System_CAPS_pubpropertyParent

Gets or sets the installer containing the collection that this installer belongs to.(Inherited from Installer.)

System_CAPS_pubpropertySite

Gets or sets the ISite of the Component.(Inherited from Component.)

System_CAPS_pubpropertyUninstallAction

Gets a value that indicates whether the performance counter should be removed at uninstall time.

NameDescription
System_CAPS_pubmethodCommit(IDictionary)

When overridden in a derived class, completes the install transaction.(Inherited from Installer.)

System_CAPS_pubmethodCopyFromComponent(IComponent)

Copies all the properties from the specified component that are required at install time for a performance counter.(Overrides ComponentInstaller.CopyFromComponent(IComponent).)

System_CAPS_pubmethodCreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodDispose()

Releases all resources used by the Component.(Inherited from Component.)

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the Component and optionally releases the managed resources.(Inherited from Component.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.(Inherited from Component.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodGetService(Type)

Returns an object that represents a service provided by the Component or by its Container.(Inherited from Component.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodInstall(IDictionary)

Performs the installation.(Overrides Installer.Install(IDictionary).)

System_CAPS_pubmethodIsEquivalentInstaller(ComponentInstaller)

Determines if the specified installer installs the same object as this installer.(Inherited from ComponentInstaller.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodOnAfterInstall(IDictionary)

Raises the AfterInstall event.(Inherited from Installer.)

System_CAPS_protmethodOnAfterRollback(IDictionary)

Raises the AfterRollback event.(Inherited from Installer.)

System_CAPS_protmethodOnAfterUninstall(IDictionary)

Raises the AfterUninstall event.(Inherited from Installer.)

System_CAPS_protmethodOnBeforeInstall(IDictionary)

Raises the BeforeInstall event.(Inherited from Installer.)

System_CAPS_protmethodOnBeforeRollback(IDictionary)

Raises the BeforeRollback event.(Inherited from Installer.)

System_CAPS_protmethodOnBeforeUninstall(IDictionary)

Raises the BeforeUninstall event.(Inherited from Installer.)

System_CAPS_protmethodOnCommitted(IDictionary)

Raises the Committed event.(Inherited from Installer.)

System_CAPS_protmethodOnCommitting(IDictionary)

Raises the Committing event.(Inherited from Installer.)

System_CAPS_pubmethodRollback(IDictionary)

Restores the computer to the state it was in before the installation.(Overrides Installer.Rollback(IDictionary).)

System_CAPS_pubmethodToString()

Returns a String containing the name of the Component, if any. This method should not be overridden.(Inherited from Component.)

System_CAPS_pubmethodUninstall(IDictionary)

Removes an installation.(Overrides Installer.Uninstall(IDictionary).)

NameDescription
System_CAPS_pubeventAfterInstall

Occurs after the Install methods of all the installers in the Installers property have run.(Inherited from Installer.)

System_CAPS_pubeventAfterRollback

Occurs after the installations of all the installers in the Installers property are rolled back.(Inherited from Installer.)

System_CAPS_pubeventAfterUninstall

Occurs after all the installers in the Installers property perform their uninstallation operations.(Inherited from Installer.)

System_CAPS_pubeventBeforeInstall

Occurs before the Install method of each installer in the installer collection has run.(Inherited from Installer.)

System_CAPS_pubeventBeforeRollback

Occurs before the installers in the Installers property are rolled back.(Inherited from Installer.)

System_CAPS_pubeventBeforeUninstall

Occurs before the installers in the Installers property perform their uninstall operations.(Inherited from Installer.)

System_CAPS_pubeventCommitted

Occurs after all the installers in the Installers property have committed their installations.(Inherited from Installer.)

System_CAPS_pubeventCommitting

Occurs before the installers in the Installers property committ their installations.(Inherited from Installer.)

System_CAPS_pubeventDisposed

Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)

The following information might help provide a performance improvement when installing performance counters at application startup. Performance counter categories installed with .NET Framework version 2.0 use separate shared memories, with each performance counter category having its own memory. You can specify the size of separate shared memory by creating a DWORD named FileMappingSize in the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\<category name>\Performance. The FileMappingSize value is set to the shared memory size of the category. The default size is 131072 decimal. If the FileMappingSize value is not present, the fileMappingSize attribute value for the performanceCounters element specified in the Machine.config file is used, causing additional overhead for configuration file processing. You can realize a performance improvement for application startup by setting the file mapping size in the registry.

The following code example demonstrates how to create a PerformanceCounterInstaller object and add it to an InstallerCollection.

using System;
using System.Configuration.Install;
using System.Diagnostics;
using System.ComponentModel;

[RunInstaller(true)]
public class MyPerformanceCounterInstaller : Installer
{
    public MyPerformanceCounterInstaller()
    {
        try
        {
            // Create an instance of 'PerformanceCounterInstaller'.
            PerformanceCounterInstaller myPerformanceCounterInstaller =
               new PerformanceCounterInstaller();
            // Set the 'CategoryName' for performance counter.
            myPerformanceCounterInstaller.CategoryName =
               "MyPerformanceCounter";
            CounterCreationData myCounterCreation = new CounterCreationData();
            myCounterCreation.CounterName = "MyCounter";
            myCounterCreation.CounterHelp = "Counter Help";
            // Add a counter to collection of  myPerformanceCounterInstaller.
            myPerformanceCounterInstaller.Counters.Add(myCounterCreation);
            Installers.Add(myPerformanceCounterInstaller);
        }
        catch (Exception e)
        {
            this.Context.LogMessage("Error occured :" + e.Message);
        }
    }
    public static void Main()
    {
    }
}

.NET Framework
Available since 1.1

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

Return to top
Show:
© 2016 Microsoft