EventLogInstaller Класс

Определение

Позволяет устанавливать и настраивать журнал событий, используемый для считывания и записи данных при запуске приложения.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
Наследование

Примеры

В следующем примере кода задаются свойства установки для нового источника событий.The following code example sets the installation properties for a new event source. В примере кода задается имя источника и имя журнала событий и добавляется в EventLogInstaller Installers коллекцию.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.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

Комментарии

Используется EventLogInstaller Installutil.exe (установщик) при установке журнала событий.The EventLogInstaller is used by the Installutil.exe (Installer Tool) when installing an event log. EventLogInstallerКласс может устанавливать журналы событий только на локальном компьютере.The EventLogInstaller class can install event logs only on the local computer.

Используйте EventLogInstaller класс, когда приложение записывает данные в журнал событий; необязательно использовать установщик журнала событий для чтения приложения из журнала событий.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. Приложения и службы должны записывать в журнал приложений или пользовательский журнал.Applications and services should write to the Application log or a custom log. Драйверы устройств должны записывать в системный журнал.Device drivers should write to the System log.

Примечание

Журнал безопасности доступен только для чтения.The Security log is read-only.

Установщик создает источник событий, Source указанный в свойстве, и регистрирует его для журнала событий, указанного в Log свойстве.The installer creates the event source that you specify in the Source property and registers it for the event log specified in Log property. Такое поведение аналогично вызову CreateEventSource для EventLog компонента.This behavior is similar to calling CreateEventSource on the EventLog component.

Используйте WriteEvent методы и WriteEntry для записи событий в журнал событий.Use the WriteEvent and WriteEntry methods to write events to an event log. Для записи событий необходимо указать источник события. перед записью первой записи с источником необходимо создать и настроить источник события.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.

Создайте новый источник событий во время установки приложения.Create the new event source during the installation of your application. Это позволяет операционной системе обновлять список зарегистрированных источников событий и их конфигураций.This allows time for the operating system to refresh its list of registered event sources and their configurations. Если операционная система не обновила список источников событий и вы пытаетесь написать событие с новым источником, операция записи завершится ошибкой.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. Новый источник можно настроить с помощью EventLogInstaller или с помощью CreateEventSource метода.You can configure a new source using an EventLogInstaller, or using the CreateEventSource method. Для создания нового источника событий необходимо иметь права администратора на компьютере.You must have administrative rights on the computer to create a new event source.

Можно создать источник событий для существующего журнала событий или нового журнала событий.You can create an event source for an existing event log or a new event log. При создании нового источника для нового журнала событий система регистрирует источник для этого журнала, но журнал не создается, пока в него не будет записана первая запись.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.

Чтобы установить журнал событий, создайте класс установщика проекта, наследующий от Installer , и задайте RunInstallerAttribute для класса значение true .To install an event log, create a project installer class that inherits from Installer, and set the RunInstallerAttribute for the class to true. В проекте создайте EventLogInstaller для каждого журнала событий, в который приложение будет выполнять запись, и добавьте экземпляр в класс установщика проекта.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.

При вызове Installutil.exe (установщик) он просматривает RunInstallerAttribute .When the Installutil.exe (Installer Tool) is called, it looks at the RunInstallerAttribute. Если это так true , средство устанавливает все элементы Installers коллекции, связанные с установщиком проекта.If it is true, the tool installs all the items in the Installers collection that are associated with your project installer. Если RunInstallerAttribute имеет значение false , средство игнорирует установщик проекта.If RunInstallerAttribute is false, the tool ignores the project installer.

Вы изменяете другие свойства EventLogInstaller либо до, либо после добавления экземпляра в Installers коллекцию установщика проекта, но перед запуском средства установки.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. SourceЕсли приложение будет записывать данные в журнал событий, необходимо задать свойство.You must set the Source property if your application will be writing to the event log.

Используется EventLogInstaller для регистрации нового источника для нового или существующего журнала событий; не используйте EventLogInstaller для изменения существующего источника.Use EventLogInstaller to register a new source for a new or existing event log; do not use EventLogInstaller to change an existing source. EventLogInstallerКласс не изменяет свойства конфигурации существующего источника в соответствии с указанными свойствами установки.The EventLogInstaller class does not modify the configuration properties of an existing source to match the specified installation properties. InstallМетод создает исключение, если Source свойство соответствует имени источника, зарегистрированному для другого журнала событий на компьютере.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. InstallМетод не регистрирует источник Source , если свойство соответствует имени источника, которое уже зарегистрировано для того же журнала событий, указанного в Log свойстве.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.

Вы можете зарегистрировать источник событий в локализованных файлах ресурсов для категории событий и строк сообщений.You can register the event source with localized resource files for your event category and message strings. Приложение может записывать записи журнала событий с помощью идентификаторов ресурсов вместо того, чтобы указывать фактическую строку.Your application can write event log entries using resource identifiers, rather than specifying the actual string. Просмотр событий использует идентификатор ресурса для поиска и вывода соответствующей строки из локализованного файла ресурсов на основе текущих языковых параметров.The Event Viewer uses the resource identifier to find and display the corresponding string from the localized resource file based on current language settings. Можно зарегистрировать отдельный файл для категорий событий, сообщений и строк вставки параметров или зарегистрировать один и тот же файл ресурсов для всех трех типов строк.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. Используйте CategoryCount свойства, CategoryResourceFile , MessageResourceFile и, ParameterResourceFile чтобы настроить источник для записи локализованных записей в журнал событий.Use the CategoryCount, CategoryResourceFile, MessageResourceFile, and ParameterResourceFile properties to configure the source to write localized entries to the event log. Если приложение записывает значения строк непосредственно в журнал событий, задавать эти свойства не нужно.If your application writes strings values directly to the event log, you do not need to set these properties.

Источник должен быть настроен либо для записи локализованных записей, либо для записи прямых строк.The source must be configured either for writing localized entries or for writing direct strings. Если приложение записывает записи, используя как идентификаторы ресурсов, так и строковые значения, необходимо зарегистрировать два отдельных источника.If your application writes entries using both resource identifiers and string values, you must register two separate sources. Например, можно настроить один источник с файлами ресурсов, а затем использовать этот источник в WriteEvent методе для записи записей, использующих идентификаторы ресурсов, в журнал событий.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. Создайте другой источник без файлов ресурсов, а затем используйте этот источник в WriteEntry методе для записи строк непосредственно в журнал событий с помощью этого источника.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.

Как правило, методы класса не вызываются EventLogInstaller из кода. они обычно вызываются только 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. Средство автоматически вызывает Install метод во время процесса установки.The tool automatically calls the Install method during the installation process. При необходимости он создает ошибки, вызывая Rollback метод для объекта, создавшего исключение.It backs out failures, if necessary, by calling the Rollback method for the object that generated the exception.

Конструкторы

EventLogInstaller()

Инициализирует новый экземпляр класса EventLogInstaller.Initializes a new instance of the EventLogInstaller class.

Свойства

CanRaiseEvents

Возвращает значение, показывающее, может ли компонент вызывать событие.Gets a value indicating whether the component can raise an event.

(Унаследовано от Component)
CategoryCount

Получает или задает число категорий в файле ресурсов категорий.Gets or sets the number of categories in the category resource file.

CategoryResourceFile

Получает или задает путь к файлу ресурсов, содержащему строки категорий источника.Gets or sets the path of the resource file that contains category strings for the source.

Container

Возвращает объект IContainer, который содержит коллекцию Component.Gets the IContainer that contains the Component.

(Унаследовано от Component)
Context

Получает или задает сведения о текущей установке.Gets or sets information about the current installation.

(Унаследовано от Installer)
DesignMode

Возвращает значение, указывающее, находится ли данный компонент Component в режиме конструктора в настоящее время.Gets a value that indicates whether the Component is currently in design mode.

(Унаследовано от Component)
Events

Возвращает список обработчиков событий, которые прикреплены к этому объекту Component.Gets the list of event handlers that are attached to this Component.

(Унаследовано от Component)
HelpText

Получает текст справки для всех установщиков из коллекции установщиков.Gets the help text for all the installers in the installer collection.

(Унаследовано от Installer)
Installers

Получает коллекцию установщиков, содержащуюся в данном установщике.Gets the collection of installers that this installer contains.

(Унаследовано от Installer)
Log

Получает или задает имя журнала, для которого задается источник.Gets or sets the name of the log to set the source to.

MessageResourceFile

Получает или задает путь к файлу ресурсов, содержащий сообщение о форматировании строк источника.Gets or sets the path of the resource file that contains message formatting strings for the source.

ParameterResourceFile

Получает или задает путь к файлу ресурсов, содержащему строки параметров сообщения источника.Gets or sets the path of the resource file that contains message parameter strings for the source.

Parent

Получает или задает установщик, содержащий коллекцию, к которой принадлежит данный установщик.Gets or sets the installer containing the collection that this installer belongs to.

(Унаследовано от Installer)
Site

Получает или задает ISite объекта Component.Gets or sets the ISite of the Component.

(Унаследовано от Component)
Source

Получает или задает имя источника, регистрируемого в журнале.Gets or sets the source name to register with the log.

UninstallAction

Получает или задает значение, указывающее, должно ли средство Installutil.exe (установщик) удалить журнал событий или оставить его в текущем состоянии во время удаления.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.

Методы

Commit(IDictionary)

Завершает транзакцию установки, если переопределен в наследующем классе.When overridden in a derived class, completes the install transaction.

(Унаследовано от Installer)
CopyFromComponent(IComponent)

Копирует значения свойств компонента EventLog, которые требуются во время установки журнала событий.Copies the property values of an EventLog component that are required at installation time for an event log.

CreateObjRef(Type)

Создает объект, который содержит всю необходимую информацию для создания прокси-сервера, используемого для взаимодействия с удаленным объектом.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Унаследовано от MarshalByRefObject)
Dispose()

Освобождает все ресурсы, занятые модулем Component.Releases all resources used by the Component.

(Унаследовано от Component)
Dispose(Boolean)

Освобождает неуправляемые ресурсы, используемые объектом Component, а при необходимости освобождает также управляемые ресурсы.Releases the unmanaged resources used by the Component and optionally releases the managed resources.

(Унаследовано от Component)
Equals(Object)

Определяет, равен ли указанный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetLifetimeService()

Извлекает объект обслуживания во время существования, который управляет политикой времени существования данного экземпляра.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Унаследовано от MarshalByRefObject)
GetService(Type)

Возвращает объект, представляющий службу, предоставляемую классом Component или классом Container.Returns an object that represents a service provided by the Component or by its Container.

(Унаследовано от Component)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
InitializeLifetimeService()

Получает объект службы времени существования для управления политикой времени существования для этого экземпляра.Obtains a lifetime service object to control the lifetime policy for this instance.

(Унаследовано от MarshalByRefObject)
Install(IDictionary)

Выполняет установку и записывает в реестр сведения о журнале событий.Performs the installation and writes event log information to the registry.

IsEquivalentInstaller(ComponentInstaller)

Определяет, ссылается ли установщик на тот же источник, что и другой указанный установщик.Determines whether an installer and another specified installer refer to the same source.

MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
MemberwiseClone(Boolean)

Создает неполную копию текущего объекта MarshalByRefObject.Creates a shallow copy of the current MarshalByRefObject object.

(Унаследовано от MarshalByRefObject)
OnAfterInstall(IDictionary)

Вызывает событие AfterInstall.Raises the AfterInstall event.

(Унаследовано от Installer)
OnAfterRollback(IDictionary)

Вызывает событие AfterRollback.Raises the AfterRollback event.

(Унаследовано от Installer)
OnAfterUninstall(IDictionary)

Вызывает событие AfterUninstall.Raises the AfterUninstall event.

(Унаследовано от Installer)
OnBeforeInstall(IDictionary)

Вызывает событие BeforeInstall.Raises the BeforeInstall event.

(Унаследовано от Installer)
OnBeforeRollback(IDictionary)

Вызывает событие BeforeRollback.Raises the BeforeRollback event.

(Унаследовано от Installer)
OnBeforeUninstall(IDictionary)

Вызывает событие BeforeUninstall.Raises the BeforeUninstall event.

(Унаследовано от Installer)
OnCommitted(IDictionary)

Вызывает событие Committed.Raises the Committed event.

(Унаследовано от Installer)
OnCommitting(IDictionary)

Вызывает событие Committing.Raises the Committing event.

(Унаследовано от Installer)
Rollback(IDictionary)

Восстанавливает исходное состояние компьютера (до установки) путем отмены данных журнала событий, внесенных в реестр в процессе установки.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()

Возвращает объект String, содержащий имя Component, если оно есть.Returns a String containing the name of the Component, if any. Этот метод не следует переопределять.This method should not be overridden.

(Унаследовано от Component)
Uninstall(IDictionary)

Удаляет из реестра сведения о журнале событий.Removes an installation by removing event log information from the registry.

События

AfterInstall

Происходит после выполнения методов Install(IDictionary) всех установщиков из свойства Installers.Occurs after the Install(IDictionary) methods of all the installers in the Installers property have run.

(Унаследовано от Installer)
AfterRollback

Происходит после отката установок всех установщиков из свойства Installers.Occurs after the installations of all the installers in the Installers property are rolled back.

(Унаследовано от Installer)
AfterUninstall

Происходит после выполнения операций удаления всеми установщиками из свойства Installers.Occurs after all the installers in the Installers property perform their uninstallation operations.

(Унаследовано от Installer)
BeforeInstall

Происходит до того, как был запущен метод Install(IDictionary) каждого установщика из коллекции установщиков.Occurs before the Install(IDictionary) method of each installer in the installer collection has run.

(Унаследовано от Installer)
BeforeRollback

Происходит до отката установщиков из свойства Installers.Occurs before the installers in the Installers property are rolled back.

(Унаследовано от Installer)
BeforeUninstall

Происходит до выполнения операций удаления установщиками из свойства Installers.Occurs before the installers in the Installers property perform their uninstall operations.

(Унаследовано от Installer)
Committed

Происходит после фиксации установки всеми установщиками из свойства Installers.Occurs after all the installers in the Installers property have committed their installations.

(Унаследовано от Installer)
Committing

Происходит до фиксации установок установщиками из свойства Installers.Occurs before the installers in the Installers property commit their installations.

(Унаследовано от Installer)
Disposed

Возникает при удалении компонента путем вызова метода Dispose().Occurs when the component is disposed by a call to the Dispose() method.

(Унаследовано от Component)

Применяется к

См. также раздел