EventLogInstaller Classe

Référence

Définition

Espace de noms:: System.Diagnostics

Assembly:: System.Configuration.Install.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Vous permet d'installer et de configurer un journal des événements que votre application lit et dans lequel elle écrit pendant l'exécution.

public ref class EventLogInstaller : System::Configuration::Install::ComponentInstaller

public class EventLogInstaller : System.Configuration.Install.ComponentInstaller

type EventLogInstaller = class
    inherit ComponentInstaller

Public Class EventLogInstaller
Inherits ComponentInstaller

Héritage: Object

MarshalByRefObject

Component

Installer

ComponentInstaller
EventLogInstaller

Exemples

L’exemple de code suivant définit les propriétés d’installation d’une nouvelle source d’événement. L’exemple de code définit le nom de la source et le nom du journal des événements, puis ajoute à EventLogInstaller la Installers collection.

#using <System.dll>
#using <System.Configuration.Install.dll>

using namespace System;
using namespace System::Configuration::Install;
using namespace System::Diagnostics;
using namespace System::ComponentModel;

[RunInstaller(true)]
ref class MyEventLogInstaller: public Installer
{
private:
   EventLogInstaller^ myEventLogInstaller;

public:
   MyEventLogInstaller()
   {
      // Create an instance of an EventLogInstaller.
      myEventLogInstaller = gcnew EventLogInstaller;

      // Set the source name of the event log.
      myEventLogInstaller->Source = "NewLogSource";
         
      // Set the event log that the source writes entries to.
      myEventLogInstaller->Log = "MyNewLog";
         
      // Add myEventLogInstaller to the Installer collection.
      Installers->Add( myEventLogInstaller );
   }
};

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

[RunInstaller(true)]
public class MyEventLogInstaller: Installer
{
    private EventLogInstaller myEventLogInstaller;

    public MyEventLogInstaller()
    {
        // Create an instance of an EventLogInstaller.
        myEventLogInstaller = new EventLogInstaller();

        // Set the source name of the event log.
        myEventLogInstaller.Source = "NewLogSource";

        // Set the event log that the source writes entries to.
        myEventLogInstaller.Log = "MyNewLog";

        // Add myEventLogInstaller to the Installer collection.
        Installers.Add(myEventLogInstaller);
    }

    public static void Main()
    {
        MyEventLogInstaller myInstaller = new MyEventLogInstaller();
    }
}

   Imports System.Configuration.Install
Imports System.Diagnostics
Imports System.ComponentModel

<RunInstaller(True)>  _
Public Class MyEventLogInstaller
   Inherits Installer
   Private myEventLogInstaller As EventLogInstaller
   
   Public Sub New()

      ' Create an instance of an EventLogInstaller.
      myEventLogInstaller = New EventLogInstaller()

      ' Set the source name of the event log.
      myEventLogInstaller.Source = "NewLogSource"

      ' Set the event log that the source writes entries to.
      myEventLogInstaller.Log = "MyNewLog"

      ' Add myEventLogInstaller to the Installer collection.
      Installers.Add(myEventLogInstaller)
   End Sub

 Public Shared Sub Main()
 End Sub
 Dim myInstaller As New EventLogInstaller()
End Class

Remarques

le EventLogInstaller est utilisé par le Installutil.exe (outil d’installation) lors de l’installation d’un journal des événements. La EventLogInstaller classe peut installer les journaux des événements uniquement sur l’ordinateur local.

Utilisez la EventLogInstaller classe lorsque votre application écrit dans un journal des événements ; il n’est pas nécessaire d’utiliser un programme d’installation du journal des événements pour que votre application lise à partir d’un journal des événements. Les applications et les services doivent écrire dans le journal des applications ou dans un journal personnalisé. Les pilotes de périphérique doivent écrire dans le journal système.

Notes

Le journal de sécurité est en lecture seule.

Le programme d’installation crée la source d’événements que vous spécifiez dans la Source propriété et l’inscrit pour le journal des événements spécifié dans Log la propriété . Ce comportement est similaire à l’appel CreateEventSource sur le EventLog composant.

Utilisez les WriteEvent méthodes et WriteEntry pour écrire des événements dans un journal des événements. Vous devez spécifier une source d’événement pour écrire des événements ; vous devez créer et configurer la source d’événement avant d’écrire la première entrée avec la source.

Créez la source d’événement lors de l’installation de votre application. Cela laisse le temps au système d’exploitation d’actualiser sa liste de sources d’événements inscrites et leurs configurations. Si le système d’exploitation n’a pas actualisé sa liste de sources d’événements et que vous tentez d’écrire un événement avec la nouvelle source, l’opération d’écriture échoue. Vous pouvez configurer une nouvelle source à l’aide d’un EventLogInstaller, ou à l’aide de la CreateEventSource méthode . Vous devez disposer des droits d’administration sur l’ordinateur pour créer une source d’événement.

Vous pouvez créer une source d’événements pour un journal des événements existant ou un nouveau journal des événements. Lorsque vous créez une source pour un nouveau journal des événements, le système enregistre la source pour ce journal, mais le journal n’est créé qu’une fois que la première entrée n’y est pas écrite.

Pour installer un journal des événements, créez une classe de programme d’installation de projet qui hérite de Installer, puis définissez pour RunInstallerAttribute la classe truesur . Dans votre projet, créez un pour chaque journal des EventLogInstaller événements dans lequel votre application écrit et ajoutez l’instance à votre classe d’installation de projet.

Lorsque le Installutil.exe (outil d’installation) est appelé, il examine le RunInstallerAttribute. S’il s’agit truede , l’outil installe tous les éléments de la Installers collection associés au programme d’installation de votre projet. Si RunInstallerAttribute a la valeur false, l’outil ignore le programme d’installation du projet.

Vous modifiez d’autres propriétés d’un EventLogInstaller avant ou après l’ajout de l’instance à la Installers collection du programme d’installation de votre projet, mais avant l’exécution de l’outil d’installation. Vous devez définir la Source propriété si votre application écrit dans le journal des événements.

Utilisez EventLogInstaller pour inscrire une nouvelle source pour un journal des événements nouveau ou existant ; n’utilisez EventLogInstaller pas pour modifier une source existante. La EventLogInstaller classe ne modifie pas les propriétés de configuration d’une source existante pour qu’elles correspondent aux propriétés d’installation spécifiées. La Install méthode lève une exception si la Source propriété correspond à un nom de source inscrit pour un autre journal des événements sur l’ordinateur. La Install méthode n’inscrit pas la source si la Source propriété correspond à un nom de source déjà inscrit pour le journal des événements spécifié dans la Log propriété .

Vous pouvez inscrire la source de l’événement avec des fichiers de ressources localisés pour votre catégorie d’événement et vos chaînes de message. Votre application peut écrire des entrées de journal des événements à l’aide d’identificateurs de ressource, plutôt que de spécifier la chaîne réelle. L’Observateur d’événements utilise l’identificateur de ressource pour rechercher et afficher la chaîne correspondante à partir du fichier de ressources localisé en fonction des paramètres de langue actuels. Vous pouvez inscrire un fichier distinct pour les catégories d’événements, les messages et les chaînes d’insertion de paramètres, ou vous pouvez inscrire le même fichier de ressources pour les trois types de chaînes. Utilisez les CategoryCountpropriétés , CategoryResourceFile, MessageResourceFileet ParameterResourceFile pour configurer la source afin d’écrire des entrées localisées dans le journal des événements. Si votre application écrit des valeurs de chaînes directement dans le journal des événements, vous n’avez pas besoin de définir ces propriétés.

La source doit être configurée pour écrire des entrées localisées ou pour écrire des chaînes directes. Si votre application écrit des entrées à l’aide d’identificateurs de ressource et de valeurs de chaîne, vous devez inscrire deux sources distinctes. Par exemple, configurez une source avec des fichiers de ressources, puis utilisez cette source dans la WriteEvent méthode pour écrire des entrées à l’aide d’identificateurs de ressource dans le journal des événements. Créez une autre source sans fichiers de ressources, puis utilisez cette source dans la WriteEntry méthode pour écrire des chaînes directement dans le journal des événements à l’aide de cette source.

En règle générale, vous n’appelez pas les méthodes de la EventLogInstaller classe à partir de votre code ; elles sont généralement appelées uniquement par Installutil.exe. L’outil appelle automatiquement la Install méthode pendant le processus d’installation. Il sauvegarde les échecs, si nécessaire, en appelant la Rollback méthode pour l’objet qui a généré l’exception.

Constructeurs

EventLogInstaller()

Initialise une nouvelle instance de la classe EventLogInstaller.

Propriétés

CanRaiseEvents	Obtient une valeur qui indique si le composant peut déclencher un événement. (Hérité de Component)
CategoryCount	Obtient ou définit le numéro de catégorie dans le fichier de ressources de catégorie.
CategoryResourceFile	Obtient ou définit le chemin d'accès du fichier de ressources contenant des chaînes de catégorie pour la source.
Container	Obtient le IContainer qui contient la Component. (Hérité de Component)
Context	Obtient ou définit des informations sur l'installation en cours. (Hérité de Installer)
DesignMode	Obtient une valeur qui indique si Component est actuellement en mode design. (Hérité de Component)
Events	Obtient la liste des gestionnaires d'événements attachés à ce Component. (Hérité de Component)
HelpText	Obtient le texte d’aide pour tous les programmes d’installation de la collection de programmes d’installation. (Hérité de Installer)
Installers	Obtient la collection de programmes d’installation contenue dans ce programme d’installation. (Hérité de Installer)
Log	Obtient ou définit le nom du journal pour lequel définir la source.
MessageResourceFile	Obtient ou définit le chemin d'accès du fichier de ressources qui contient des chaînes de mise en forme du message pour la source.
ParameterResourceFile	Obtient ou définit le chemin d'accès du fichier de ressources qui contient des chaînes de paramètre du message pour la source.
Parent	Obtient ou définit le programme d'installation contenant la collection à laquelle appartient ce programme d'installation. (Hérité de Installer)
Site	Obtient ou définit le ISite de Component. (Hérité de Component)
Source	Obtient ou définit le nom de source à enregistrer auprès du journal.
UninstallAction	Obtient ou définit une valeur qui indique si l’outil d’installation (Installutil.exe) doit supprimer le journal des événements ou le laisser à son état d’installation au moment de la désinstallation.

Méthodes

Commit(IDictionary)	En cas de substitution dans une classe dérivée, termine la transaction d’installation. (Hérité de Installer)
CopyFromComponent(IComponent)	Copie les valeurs des propriétés d'un composant EventLog requises lors de l'installation d'un journal des événements.
CreateObjRef(Type)	Crée un objet contenant toutes les informations appropriées requises pour générer un proxy permettant de communiquer avec un objet distant. (Hérité de MarshalByRefObject)
Dispose()	Libère toutes les ressources utilisées par Component. (Hérité de Component)
Dispose(Boolean)	Libère les ressources non managées utilisées par Component et libère éventuellement les ressources managées. (Hérité de Component)
Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetLifetimeService()	Obsolète. Récupère l'objet de service de durée de vie en cours qui contrôle la stratégie de durée de vie de cette instance. (Hérité de MarshalByRefObject)
GetService(Type)	Retourne un objet qui représente un service fourni par Component ou par son Container. (Hérité de Component)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
InitializeLifetimeService()	Obsolète. Obtient un objet de service de durée de vie pour contrôler la stratégie de durée de vie de cette instance. (Hérité de MarshalByRefObject)
Install(IDictionary)	Exécute l'installation et écrit les informations du journal des événements dans le Registre.
IsEquivalentInstaller(ComponentInstaller)	Détermine si un programme d'installation et un autre programme d'installation spécifié font référence à la même source.
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
MemberwiseClone(Boolean)	Crée une copie superficielle de l'objet MarshalByRefObject actuel. (Hérité de MarshalByRefObject)
OnAfterInstall(IDictionary)	Déclenche l’événement AfterInstall. (Hérité de Installer)
OnAfterRollback(IDictionary)	Déclenche l’événement AfterRollback. (Hérité de Installer)
OnAfterUninstall(IDictionary)	Déclenche l’événement AfterUninstall. (Hérité de Installer)
OnBeforeInstall(IDictionary)	Déclenche l’événement BeforeInstall. (Hérité de Installer)
OnBeforeRollback(IDictionary)	Déclenche l’événement BeforeRollback. (Hérité de Installer)
OnBeforeUninstall(IDictionary)	Déclenche l’événement BeforeUninstall. (Hérité de Installer)
OnCommitted(IDictionary)	Déclenche l’événement Committed. (Hérité de Installer)
OnCommitting(IDictionary)	Déclenche l’événement Committing. (Hérité de Installer)
Rollback(IDictionary)	Restaure l'état qui était celui de l'ordinateur avant l'installation en restaurant les informations du journal des événements écrites dans le Registre pendant la procédure d'installation.
ToString()	Retourne un String contenant le nom du Component, s’il en existe un. Cette méthode ne doit pas être remplacée. (Hérité de Component)
Uninstall(IDictionary)	Supprime une installation en enlevant du Registre les informations du journal des événements.

Événements

AfterInstall	Se produit après l'exécution des méthodes Install(IDictionary) de tous les programmes d'installation de la propriété Installers. (Hérité de Installer)
AfterRollback	Se produit après la restauration des installations de tous les programmes d'installation de la propriété Installers. (Hérité de Installer)
AfterUninstall	Se produit une fois que tous les programmes d'installation de la propriété Installers ont effectué leurs propres opérations de désinstallation. (Hérité de Installer)
BeforeInstall	Se produit avant l’exécution de la méthode Install(IDictionary) de chaque programme d’installation contenu dans la collection de programmes d’installation. (Hérité de Installer)
BeforeRollback	Se produit avant la restauration des programmes d'installation de la propriété Installers. (Hérité de Installer)
BeforeUninstall	Se produit avant que les programmes d'installation de la propriété Installers aient effectué leurs propres opérations de désinstallation. (Hérité de Installer)
Committed	Se produit après la validation de l'installation de tous les programmes d'installation de la propriété Installers. (Hérité de Installer)
Committing	Se produit avant la validation de l’installation des programmes d’installation de la propriété Installers. (Hérité de Installer)
Disposed	Se produit lorsque le composant est supprimé par un appel à la méthode Dispose(). (Hérité de Component)

S’applique à

Partager via