EventInstance Classe

Definição

public ref class EventInstance

public class EventInstance

type EventInstance = class

Public Class EventInstance

Herança

Object

EventInstance

Exemplos

O exemplo de código seguinte escreve uma entrada de evento informativo e depois reutiliza o EventInstance para escrever uma entrada para um evento de aviso num registo de eventos existente. O texto da mensagem do evento é especificado usando um identificador de recurso num ficheiro de recurso de mensagem. O exemplo de código assume que o ficheiro de recurso de mensagem correspondente foi registado para a fonte.

// Ensure that the source has already been registered using
// EventLogInstaller or EventLog.CreateEventSource.

string sourceName = "SampleApplicationSource";
if(EventLog.SourceExists(sourceName))
{
    // Define an informational event with no category.
    // The message identifier corresponds to the message text in the
    // message resource file defined for the source.
    EventInstance myEvent = new EventInstance(UpdateCycleCompleteMsgId, 0);

    // Write the event to the event log using the registered source.
    EventLog.WriteEvent(sourceName, myEvent);

    // Reuse the event data instance for another event entry.
    // Set the entry category and message identifiers for
    // the appropriate resource identifiers in the resource files
    // for the registered source.  Set the event type to Warning.

    myEvent.CategoryId = RefreshCategoryMsgId;
    myEvent.EntryType = EventLogEntryType.Warning;
    myEvent.InstanceId = ServerConnectionDownMsgId;

    // Write the event to the event log using the registered source.
    // Insert the machine name into the event message text.
    EventLog.WriteEvent(sourceName, myEvent, Environment.MachineName);
}
else
{
    Console.WriteLine("Warning - event source {0} not registered",
        sourceName);
}

' Ensure that the source has already been registered using
' EventLogInstaller or EventLog.CreateEventSource.
Dim sourceName as String = "SampleApplicationSource"
If EventLog.SourceExists(sourceName)
    
    ' Define an informational event with no category.
    ' The message identifier corresponds to the message text in the
    ' message resource file defined for the source.
    Dim myEvent As EventInstance = New EventInstance(UpdateCycleCompleteMsgId, 0)
    ' Write the event to the event log using the registered source.
    EventLog.WriteEvent(sourceName, myEvent)

    ' Reuse the event data instance for another event entry.
    ' Set the entry category and message identifiers for
    ' the appropriate resource identifiers in the resource files
    ' for the registered source.  Set the event type to Warning.

    myEvent.CategoryId = RefreshCategoryMsgId
    myEvent.EntryType = EventLogEntryType.Warning
    myEvent.InstanceId = ServerConnectionDownMsgId

    ' Write the event to the event log using the registered source.
    ' Insert the machine name into the event message text.
    EventLog.WriteEvent(sourceName, myEvent, Environment.MachineName)

Else 
    Console.WriteLine("Warning - event source {0} not registered", _
        sourceName)
End If

O exemplo de código utiliza o seguinte ficheiro de texto de mensagem, incorporado na biblioteca de recursos EventLogMsgs.dll. Um ficheiro de texto de mensagem é a fonte a partir da qual o ficheiro de recurso da mensagem é criado. O ficheiro de texto da mensagem define os identificadores de recursos e o texto para as cadeias de inserção de categoria, mensagem de evento e parâmetros.

; // EventLogMsgs.mc
; // ********************************************************

; // Use the following commands to build this file:

; //   mc -s EventLogMsgs.mc
; //   rc EventLogMsgs.rc
; //   link /DLL /SUBSYSTEM:WINDOWS /NOENTRY /MACHINE:x86 EventLogMsgs.Res
; // ********************************************************

; // - Event categories -
; // Categories must be numbered consecutively starting at 1.
; // ********************************************************

MessageId=0x1
Severity=Success
SymbolicName=INSTALL_CATEGORY
Language=English
Installation
.

MessageId=0x2
Severity=Success
SymbolicName=QUERY_CATEGORY
Language=English
Database Query
.

MessageId=0x3
Severity=Success
SymbolicName=REFRESH_CATEGORY
Language=English
Data Refresh
.

; // - Event messages -
; // *********************************

MessageId = 1000
Severity = Success
Facility = Application
SymbolicName = AUDIT_SUCCESS_MESSAGE_ID_1000
Language=English
My application message text, in English, for message id 1000, called from %1.
.

MessageId = 1001
Severity = Warning
Facility = Application
SymbolicName = AUDIT_FAILED_MESSAGE_ID_1001
Language=English
My application message text, in English, for message id 1001, called from %1.
.

MessageId = 1002
Severity = Success
Facility = Application
SymbolicName = GENERIC_INFO_MESSAGE_ID_1002
Language=English
My generic information message in English, for message id 1002.
.

MessageId = 1003
Severity = Warning
Facility = Application
SymbolicName = GENERIC_WARNING_MESSAGE_ID_1003
Language=English
My generic warning message in English, for message id 1003, called from %1.
.

MessageId = 1004
Severity = Success
Facility = Application
SymbolicName = UPDATE_CYCLE_COMPLETE_MESSAGE_ID_1004
Language=English
The update cycle is complete for %%5002.
.

MessageId = 1005
Severity = Warning
Facility = Application
SymbolicName = SERVER_CONNECTION_DOWN_MESSAGE_ID_1005
Language=English
The refresh operation did not complete because the connection to server %1 could not be established.
.

; // - Event log display name -
; // ********************************************************

MessageId = 5001
Severity = Success
Facility = Application
SymbolicName = EVENT_LOG_DISPLAY_NAME_MSGID
Language=English
Sample Event Log
.

; // - Event message parameters -
; //   Language independent insertion strings
; // ********************************************************

MessageId = 5002
Severity = Success
Facility = Application
SymbolicName = EVENT_LOG_SERVICE_NAME_MSGID
Language=English
SVC_UPDATE.EXE
.

Observações

Use EventInstance para escrever uma entrada de registo de eventos com um identificador de recurso em vez de um valor de string. Para escrever uma entrada no registo de eventos, inicialize a InstanceId propriedade e passe a instância para o WriteEvent método. O Visualizador de Eventos utiliza o identificador de instância para encontrar e mostrar a cadeia correspondente do ficheiro de recurso localizado com base nas definições de idioma atuais. Deve registar a fonte do evento com o ficheiro de recurso correspondente antes de escrever eventos usando identificadores de recursos.

Ao escrever eventos, pode definir a propriedade EntryType para especificar o ícone que a Visualizador de Eventos mostra para a entrada. Também pode especificar uma propriedade CategoryId para especificar a categoria que o Visualizador de Eventos apresenta para a entrada.

O Visualizador de Eventos utiliza a categoria para filtrar eventos escritos por uma fonte de eventos. O Visualizador de Eventos pode mostrar a categoria como um valor numérico, ou pode usar a categoria como identificador de recurso para mostrar uma cadeia de categoria localizada.

Para exibir as cadeias de categoria localizadas no Visualizador de Eventos, deve usar uma fonte de evento configurada com um ficheiro de recurso de categoria e definir o CategoryId como identificador de recurso no ficheiro de recurso da categoria. Se a fonte do evento não tiver um ficheiro de recurso de categoria configurado, ou se o CategoryId especificado não indexar uma cadeia no ficheiro de recurso da categoria, então o Visualizador de Eventos exibe o valor numérico da categoria para essa entrada. Configure o ficheiro de recurso da categoria, juntamente com o número de strings de categoria no ficheiro de recurso, usando a EventLogInstaller ou a EventSourceCreationData classe.

Deve registar uma fonte para um registo de eventos antes de usar EventInstance para escrever um evento com o WriteEvent método. A fonte deve estar configurada para escrever entradas localizadas no log e a fonte deve definir pelo menos um ficheiro de recurso de mensagem.

Crie a nova fonte de eventos durante a instalação da sua aplicação. Isto permite que o sistema operativo atualize a sua lista de fontes de eventos registadas e as suas configurações. Se o sistema operativo não atualizou a sua lista de fontes de eventos, e tentar escrever um evento com a nova fonte, a operação de escrita falhará. Pode configurar uma nova fonte usando um EventLogInstaller, ou usando o CreateEventSource método. Deve ter direitos administrativos no computador para criar uma nova fonte de eventos.

Para detalhes sobre a definição de mensagens de eventos e a construção de ficheiros de recursos do registo de eventos, consulte o artigo do Compilador de Mensagens na documentação do SDK da Plataforma.

Ver também

• WriteEvent
• EventLogEntry