EventLogInstaller EventLogInstaller EventLogInstaller EventLogInstaller Class

Definição

Permite instalar e configurar um log de eventos que o aplicativo lê ou no qual faz gravações quando está em execução.Allows you to install and configure an event log that your application reads from or writes to when running.

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
Herança

Exemplos

O exemplo de código a seguir define as propriedades de instalação para uma nova origem do evento.The following code example sets the installation properties for a new event source. O exemplo de código define o nome de origem e o nome do log de eventos e adiciona o EventLogInstaller para o Installers coleção.The code example sets the source name and the event log name, and adds the EventLogInstaller to the 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
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 'New

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

Comentários

O EventLogInstaller é usado pelas Installutil.exe (ferramenta de instalação) durante a instalação de um log de eventos.The EventLogInstaller is used by the Installutil.exe (Installer Tool) when installing an event log. O EventLogInstaller classe pode instalar os logs de eventos somente no computador local.The EventLogInstaller class can install event logs only on the local computer.

Use o EventLogInstaller classe quando seu aplicativo grava um log de eventos; não é necessário usar um instalador de log de eventos para seu aplicativo para ler de um log de eventos.Use the EventLogInstaller class when your application writes to an event log; it is not necessary to use an event log installer for your application to read from an event log. Aplicativos e serviços devem gravar no log do aplicativo ou um log personalizado.Applications and services should write to the Application log or a custom log. Drivers de dispositivo devem gravar no log do sistema.Device drivers should write to the System log.

Observação

O log de segurança é somente leitura.The Security log is read-only.

O instalador cria a origem do evento que você especificar na Source propriedade e registra-o para o log de eventos especificado em Log propriedade.The installer creates the event source that you specify in the Source property and registers it for the event log specified in Log property. Esse comportamento é semelhante a chamar CreateEventSource sobre o EventLog componente.This behavior is similar to calling CreateEventSource on the EventLog component.

Use o WriteEvent e WriteEntry métodos para gravar eventos em um log de eventos.Use the WriteEvent and WriteEntry methods to write events to an event log. Você deve especificar uma origem de evento para gravar eventos; Você deve criar e configurar a origem do evento antes de gravar a primeira entrada com o código-fonte.You must specify an event source to write events; you must create and configure the event source before writing the first entry with the source.

Crie a nova fonte de evento durante a instalação do seu aplicativo.Create the new event source during the installation of your application. Isso permite que o tempo para o sistema operacional atualizar sua lista de fontes de eventos registrados e suas configurações.This allows time for the operating system to refresh its list of registered event sources and their configurations. Se o sistema operacional não foi atualizado para a sua lista de fontes de eventos, e você tentar gravar um evento com a nova fonte, que haverá falha na operação de gravação.If the operating system has not refreshed its list of event sources, and you attempt to write an event with the new source, the write operation will fail. Você pode configurar uma nova fonte usando um EventLogInstaller, ou usando o CreateEventSource método.You can configure a new source using an EventLogInstaller, or using the CreateEventSource method. Você deve ter direitos administrativos no computador para criar uma nova fonte de evento.You must have administrative rights on the computer to create a new event source.

Você pode criar uma fonte de evento para um log de eventos existente ou um novo log de eventos.You can create an event source for an existing event log or a new event log. Quando você cria uma nova origem para um novo log de eventos, o sistema registra a origem para que o log, mas o log não é criado até que a primeira entrada seja gravada nele.When you create a new source for a new event log, the system registers the source for that log, but the log is not created until the first entry is written to it.

Para instalar um log de eventos, crie uma classe de instalador de projeto que herda de Installere defina o RunInstallerAttribute a classe true.To install an event log, create a project installer class that inherits from Installer, and set the RunInstallerAttribute for the class to true. Dentro de seu projeto, crie um EventLogInstaller para cada log de eventos que seu aplicativo gravar e adicionar a instância à sua classe de instalador de projeto.Within your project, create an EventLogInstaller for each event log that your application will write to and add the instance to your project installer class.

Quando o Installutil.exe (ferramenta de instalação) é chamado, ele examina o RunInstallerAttribute.When the Installutil.exe (Installer Tool) is called, it looks at the RunInstallerAttribute. Se ele estiver true, a ferramenta instala todos os itens a Installers coleta que estão associados com o instalador de seu projeto.If it is true, the tool installs all the items in the Installers collection that are associated with your project installer. Se RunInstallerAttribute é false, a ferramenta ignora o instalador de projeto.If RunInstallerAttribute is false, the tool ignores the project installer.

Você modificar outras propriedades de um EventLogInstaller antes ou depois de adicionar a instância para o Installers coleção de instalador de seu projeto, mas antes que a ferramenta instalador é executado.You modify other properties of an EventLogInstaller either before or after adding the instance to the Installers collection of your project installer, but before the installer tool runs. Você deve definir o Source propriedade se seu aplicativo será gravado no log de eventos.You must set the Source property if your application will be writing to the event log.

Use EventLogInstaller para registrar uma nova origem para um log de eventos novo ou existente; não use EventLogInstaller para alterar uma fonte existente.Use EventLogInstaller to register a new source for a new or existing event log; do not use EventLogInstaller to change an existing source. O EventLogInstaller classe não modifica as propriedades de configuração de uma fonte existente para corresponder as propriedades de instalação especificado.The EventLogInstaller class does not modify the configuration properties of an existing source to match the specified installation properties. O Install método lança uma exceção se o Source propriedade corresponde a um nome de origem que está registrado para outro log de eventos no computador.The Install method throws an exception if the Source property matches a source name that is registered for a different event log on the computer. O Install método não registrar a fonte se a Source propriedade corresponde a um nome de origem que já está registrado para o mesmo log de eventos especificado no Log propriedade.The Install method does not register the source if the Source property matches a source name that is already registered for the same event log specified in the Log property.

Você pode registrar a origem do evento com arquivos de recursos localizados para suas cadeias de caracteres de categoria e mensagem de evento.You can register the event source with localized resource files for your event category and message strings. Seu aplicativo pode gravar entradas de log de eventos usando identificadores de recurso, em vez de especificar a cadeia de caracteres real.Your application can write event log entries using resource identifiers, rather than specifying the actual string. O Visualizador de eventos usa o identificador de recurso para localizar e exibir a cadeia de caracteres correspondente do arquivo de recurso localizada com base nas configurações de idioma atual.The Event Viewer uses the resource identifier to find and display the corresponding string from the localized resource file based on current language settings. Você pode registrar um arquivo separado para categorias de evento, mensagens e cadeias de caracteres de inserção de parâmetro, ou você pode registrar o mesmo arquivo de recurso para todos os três tipos de cadeias de caracteres.You can register a separate file for event categories, messages, and parameter insertion strings, or you can register the same resource file for all three types of strings. Use o CategoryCount, CategoryResourceFile, MessageResourceFile, e ParameterResourceFile propriedades para configurar a fonte para gravar entradas localizadas para o log de eventos.Use the CategoryCount, CategoryResourceFile, MessageResourceFile, and ParameterResourceFile properties to configure the source to write localized entries to the event log. Se seu aplicativo grava os valores de cadeias de caracteres diretamente ao log de eventos, você precisa definir essas propriedades.If your application writes strings values directly to the event log, you do not need to set these properties.

A origem deve ser configurada para gravar entradas localizadas ou para gravação de cadeias de caracteres diretas.The source must be configured either for writing localized entries or for writing direct strings. Se seu aplicativo grava entradas usando os valores de cadeia de caracteres e identificadores de recurso, você deve registrar duas fontes separadas.If your application writes entries using both resource identifiers and string values, you must register two separate sources. Por exemplo, configure uma fonte com arquivos de recurso e, em seguida, usar essa fonte no WriteEvent método para gravar entradas usando identificadores de recurso para o log de eventos.For example, configure one source with resource files, and then use that source in the WriteEvent method to write entries using resource identifiers to the event log. Criar uma fonte diferente sem arquivos de recurso e, em seguida, usar essa fonte no WriteEntry método escrever cadeias de caracteres diretamente ao log de eventos usando essa fonte.Create a different source without resource files and then use that source in the WriteEntry method to write strings directly to the event log using that source.

Normalmente, você não chama os métodos do EventLogInstaller de classe de dentro de seu código; eles geralmente são chamados apenas por Installutil.exe.Typically, you do not call the methods of the EventLogInstaller class from within your code; they are generally called only by Installutil.exe. A ferramenta chama automaticamente o Install método durante o processo de instalação.The tool automatically calls the Install method during the installation process. Ele desfaz falhas, se necessário, chamando o Rollback método para o objeto que gerou a exceção.It backs out failures, if necessary, by calling the Rollback method for the object that generated the exception.

Construtores

EventLogInstaller() EventLogInstaller() EventLogInstaller() EventLogInstaller()

Inicializa uma nova instância da classe EventLogInstaller.Initializes a new instance of the EventLogInstaller class.

Propriedades

CanRaiseEvents CanRaiseEvents CanRaiseEvents CanRaiseEvents

Obtém um valor que indica se o componente pode acionar um evento.Gets a value indicating whether the component can raise an event.

(Inherited from Component)
CategoryCount CategoryCount CategoryCount CategoryCount

Obtém ou define o número de categorias no arquivo de recurso da categoria.Gets or sets the number of categories in the category resource file.

CategoryResourceFile CategoryResourceFile CategoryResourceFile CategoryResourceFile

Obtém ou define o caminho do arquivo de recurso que contém cadeias de caracteres da categoria para a origem.Gets or sets the path of the resource file that contains category strings for the source.

Container Container Container Container

Obtém o IContainer que contém o Component.Gets the IContainer that contains the Component.

(Inherited from Component)
Context Context Context Context

Obtém ou define informações sobre a instalação atual.Gets or sets information about the current installation.

(Inherited from Installer)
DesignMode DesignMode DesignMode DesignMode

Obtém um valor que indica se o Component está no modo de design no momento.Gets a value that indicates whether the Component is currently in design mode.

(Inherited from Component)
Events Events Events Events

Obtém a lista de manipuladores de eventos que estão anexados a este Component.Gets the list of event handlers that are attached to this Component.

(Inherited from Component)
HelpText HelpText HelpText HelpText

Obtém o texto de ajuda para todos os instaladores na coleção de instalador.Gets the help text for all the installers in the installer collection.

(Inherited from Installer)
Installers Installers Installers Installers

Obtém a coleção de instaladores que contém esse instalador.Gets the collection of installers that this installer contains.

(Inherited from Installer)
Log Log Log Log

Obtém ou define o nome do log para o qual a origem será definida.Gets or sets the name of the log to set the source to.

MessageResourceFile MessageResourceFile MessageResourceFile MessageResourceFile

Obtém ou define o caminho do arquivo de recurso que contém a formatação de mensagem para a origem.Gets or sets the path of the resource file that contains message formatting strings for the source.

ParameterResourceFile ParameterResourceFile ParameterResourceFile ParameterResourceFile

Obtém ou define o caminho do arquivo de recurso que contém as cadeias de caracteres do parâmetro da mensagem para a origem.Gets or sets the path of the resource file that contains message parameter strings for the source.

Parent Parent Parent Parent

Obtém ou define o instalador que contém a coleção à qual o instalador pertence.Gets or sets the installer containing the collection that this installer belongs to.

(Inherited from Installer)
Site Site Site Site

Obtém ou define o ISite do Component.Gets or sets the ISite of the Component.

(Inherited from Component)
Source Source Source Source

Obtém ou define o nome da origem a ser registrada com o log.Gets or sets the source name to register with the log.

UninstallAction UninstallAction UninstallAction UninstallAction

Obtém ou define um valor que indica se o Installutil.exe (Ferramenta de Instalação) deve remover o log de eventos ou deixá-lo em seu estado instalado no momento da desinstalação.Gets or sets a value that indicates whether the Installutil.exe (Installer Tool) should remove the event log or leave it in its installed state at uninstall time.

Métodos

Commit(IDictionary) Commit(IDictionary) Commit(IDictionary) Commit(IDictionary)

Quando substituído em uma classe derivada, conclui a transação de instalação.When overridden in a derived class, completes the install transaction.

(Inherited from Installer)
CopyFromComponent(IComponent) CopyFromComponent(IComponent) CopyFromComponent(IComponent) CopyFromComponent(IComponent)

Copia os valores de propriedade de um componente EventLog que são necessários no momento da instalação para um log de eventos.Copies the property values of an EventLog component that are required at installation time for an event log.

CreateObjRef(Type) CreateObjRef(Type) CreateObjRef(Type) CreateObjRef(Type)

Cria um objeto que contém todas as informações relevantes necessárias para gerar um proxy usado para se comunicar com um objeto remoto.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Inherited from MarshalByRefObject)
Dispose() Dispose() Dispose() Dispose()

Libera todos os recursos usados pelo Component.Releases all resources used by the Component.

(Inherited from Component)
Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)

Libera os recursos não gerenciados usados pelo Component e opcionalmente libera os recursos gerenciados.Releases the unmanaged resources used by the Component and optionally releases the managed resources.

(Inherited from Component)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serve como a função de hash padrão.Serves as the default hash function.

(Inherited from Object)
GetLifetimeService() GetLifetimeService() GetLifetimeService() GetLifetimeService()

Recupera o objeto de serviço de tempo de vida atual que controla a política de ciclo de vida para esta instância.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
GetService(Type) GetService(Type) GetService(Type) GetService(Type)

Retorna um objeto que representa um serviço fornecido pelo Component ou pelo seu Container.Returns an object that represents a service provided by the Component or by its Container.

(Inherited from Component)
GetType() GetType() GetType() GetType()

Obtém o Type da instância atual.Gets the Type of the current instance.

(Inherited from Object)
InitializeLifetimeService() InitializeLifetimeService() InitializeLifetimeService() InitializeLifetimeService()

Obtém um objeto de serviço de tempo de vida para controlar a política de tempo de vida para essa instância.Obtains a lifetime service object to control the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
Install(IDictionary) Install(IDictionary) Install(IDictionary) Install(IDictionary)

Executa a instalação e grava as informações de log de eventos no registro.Performs the installation and writes event log information to the registry.

IsEquivalentInstaller(ComponentInstaller) IsEquivalentInstaller(ComponentInstaller) IsEquivalentInstaller(ComponentInstaller) IsEquivalentInstaller(ComponentInstaller)

Determina se um instalador e outro instalador especificado se referem à mesma origem.Determines whether an installer and another specified installer refer to the same source.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Cria uma cópia superficial do Object atual.Creates a shallow copy of the current Object.

(Inherited from Object)
MemberwiseClone(Boolean) MemberwiseClone(Boolean) MemberwiseClone(Boolean) MemberwiseClone(Boolean)

Cria uma cópia superficial do objeto MarshalByRefObject atual.Creates a shallow copy of the current MarshalByRefObject object.

(Inherited from MarshalByRefObject)
OnAfterInstall(IDictionary) OnAfterInstall(IDictionary) OnAfterInstall(IDictionary) OnAfterInstall(IDictionary)

Aciona o evento AfterInstall.Raises the AfterInstall event.

(Inherited from Installer)
OnAfterRollback(IDictionary) OnAfterRollback(IDictionary) OnAfterRollback(IDictionary) OnAfterRollback(IDictionary)

Aciona o evento AfterRollback.Raises the AfterRollback event.

(Inherited from Installer)
OnAfterUninstall(IDictionary) OnAfterUninstall(IDictionary) OnAfterUninstall(IDictionary) OnAfterUninstall(IDictionary)

Aciona o evento AfterUninstall.Raises the AfterUninstall event.

(Inherited from Installer)
OnBeforeInstall(IDictionary) OnBeforeInstall(IDictionary) OnBeforeInstall(IDictionary) OnBeforeInstall(IDictionary)

Aciona o evento BeforeInstall.Raises the BeforeInstall event.

(Inherited from Installer)
OnBeforeRollback(IDictionary) OnBeforeRollback(IDictionary) OnBeforeRollback(IDictionary) OnBeforeRollback(IDictionary)

Aciona o evento BeforeRollback.Raises the BeforeRollback event.

(Inherited from Installer)
OnBeforeUninstall(IDictionary) OnBeforeUninstall(IDictionary) OnBeforeUninstall(IDictionary) OnBeforeUninstall(IDictionary)

Aciona o evento BeforeUninstall.Raises the BeforeUninstall event.

(Inherited from Installer)
OnCommitted(IDictionary) OnCommitted(IDictionary) OnCommitted(IDictionary) OnCommitted(IDictionary)

Aciona o evento Committed.Raises the Committed event.

(Inherited from Installer)
OnCommitting(IDictionary) OnCommitting(IDictionary) OnCommitting(IDictionary) OnCommitting(IDictionary)

Aciona o evento Committing.Raises the Committing event.

(Inherited from Installer)
Rollback(IDictionary) Rollback(IDictionary) Rollback(IDictionary) Rollback(IDictionary)

Restaura o computador para o estado em que estava antes da instalação revertendo as informações do log de eventos que o procedimento de instalação gravou no Registro.Restores the computer to the state it was in before the installation by rolling back the event log information that the installation procedure wrote to the registry.

ToString() ToString() ToString() ToString()

Retorna um String que contém o nome do Component, se houver.Returns a String containing the name of the Component, if any. Esse método não deve ser substituído.This method should not be overridden.

(Inherited from Component)
Uninstall(IDictionary) Uninstall(IDictionary) Uninstall(IDictionary) Uninstall(IDictionary)

Remove uma instalação removendo as informações do log de eventos do Registro.Removes an installation by removing event log information from the registry.

Eventos

AfterInstall AfterInstall AfterInstall AfterInstall

Ocorre depois que os métodos do Install(IDictionary) de todos os instaladores na propriedade Installers foram executados.Occurs after the Install(IDictionary) methods of all the installers in the Installers property have run.

(Inherited from Installer)
AfterRollback AfterRollback AfterRollback AfterRollback

Ocorre após as instalações de todos os instaladores na propriedade Installers serem revertidas.Occurs after the installations of all the installers in the Installers property are rolled back.

(Inherited from Installer)
AfterUninstall AfterUninstall AfterUninstall AfterUninstall

Ocorre depois que todos os instaladores na propriedade Installers realizam suas operações de desinstalação.Occurs after all the installers in the Installers property perform their uninstallation operations.

(Inherited from Installer)
BeforeInstall BeforeInstall BeforeInstall BeforeInstall

Ocorre antes do método Install(IDictionary) de cada instalador no instalador em que a coleção foi executada.Occurs before the Install(IDictionary) method of each installer in the installer collection has run.

(Inherited from Installer)
BeforeRollback BeforeRollback BeforeRollback BeforeRollback

Ocorre antes que os instaladores na propriedade Installers sejam revertidos.Occurs before the installers in the Installers property are rolled back.

(Inherited from Installer)
BeforeUninstall BeforeUninstall BeforeUninstall BeforeUninstall

Ocorre antes dos instaladores na propriedade Installers executarem suas operações de desinstalação.Occurs before the installers in the Installers property perform their uninstall operations.

(Inherited from Installer)
Committed Committed Committed Committed

Ocorre depois que todos os instaladores na propriedade Installers confirmaram suas instalações.Occurs after all the installers in the Installers property have committed their installations.

(Inherited from Installer)
Committing Committing Committing Committing

Ocorre antes que os instaladores na propriedade Installers façam commit de suas instalações.Occurs before the installers in the Installers property commit their installations.

(Inherited from Installer)
Disposed Disposed Disposed Disposed

Ocorre quando o componente é disposto por uma chamada para o método Dispose().Occurs when the component is disposed by a call to the Dispose() method.

(Inherited from Component)

Aplica-se a

Veja também