EventInstance Classe
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Representa informações com neutralidade de idioma para uma entrada de log de eventos.
public ref class EventInstancepublic class EventInstancetype EventInstance = classPublic Class EventInstance- Herança
-
EventInstance
Exemplos
O exemplo de código a seguir grava uma entrada de evento informativo e reutiliza o EventInstance para gravar uma entrada para um evento de aviso em um log de eventos existente. O texto da mensagem de evento é especificado usando um identificador de recurso em um arquivo de recurso de mensagem. O exemplo de código pressupõe que o arquivo de recurso de mensagem correspondente tenha sido registrado para a origem.
// 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 = gcnew EventInstance( UpdateCycleCompleteMsgId,0 );
// Write the event to the event log using the registered source.
EventLog::WriteEvent( sourceName, myEvent, 0 );
// 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.
array<String^>^ss = {Environment::MachineName};
EventLog::WriteEvent( sourceName, myEvent, ss );
}
else
{
Console::WriteLine( "Warning - event source {0} not registered", sourceName );
}
// 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 usa o seguinte arquivo de texto de mensagem, integrado à biblioteca de recursos EventLogMsgs.dll. Um arquivo de texto de mensagem é a origem da qual o arquivo de recurso de mensagem é criado. O arquivo de texto da mensagem define os identificadores de recurso e o texto para as cadeias de caracteres de categoria, mensagem de evento e inserção de 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
.
Comentários
Use EventInstance para gravar uma entrada de log de eventos com um identificador de recurso em vez de um valor de cadeia de caracteres. Para gravar uma entrada de log de eventos, inicialize a InstanceId propriedade e passe a instância para o WriteEvent método . O Visualizador de Eventos usa o identificador de instância para localizar e exibir a cadeia de caracteres correspondente do arquivo de recurso localizado com base nas configurações de idioma atuais. Você deve registrar a origem do evento com o arquivo de recurso correspondente antes de gravar eventos usando identificadores de recurso.
Ao gravar eventos, você pode definir a EntryType propriedade para especificar o ícone que o Visualizador de Eventos exibe para a entrada. Você também pode especificar uma CategoryId propriedade para especificar a categoria que o Visualizador de Eventos exibe para a entrada.
O Visualizador de Eventos usa a categoria para filtrar eventos gravados por uma fonte de evento. O Visualizador de Eventos pode exibir a categoria como um valor numérico ou pode usar a categoria como um identificador de recurso para exibir uma cadeia de caracteres de categoria localizada.
Para exibir cadeias de caracteres de categoria localizadas no Visualizador de Eventos, você deve usar uma fonte de evento configurada com um arquivo de recurso de categoria e definir o CategoryId como um identificador de recurso no arquivo de recurso de categoria. Se a origem do evento não tiver um arquivo de recurso de categoria configurado ou o especificado CategoryId não indexar uma cadeia de caracteres no arquivo de recurso de categoria e, em seguida, o Visualizador de Eventos exibirá o valor da categoria numérica para essa entrada. Configure o arquivo de recurso de categoria, juntamente com o número de cadeias de caracteres de categoria no arquivo de recurso, usando a EventLogInstaller classe ou EventSourceCreationData .
Você deve registrar uma origem para um log de eventos antes de usar EventInstance para gravar um evento com o WriteEvent método . A origem deve ser configurada para gravar entradas localizadas no log e a origem deve definir pelo menos um arquivo de recurso de mensagem.
Create a nova origem do evento durante a instalação do aplicativo. Isso permite tempo para o sistema operacional atualizar sua lista de fontes de eventos registradas e suas configurações. Se o sistema operacional não tiver atualizado sua lista de fontes de eventos e você tentar gravar um evento com a nova origem, a operação de gravação falhará. Você pode configurar uma nova fonte usando um EventLogInstallerou usando o CreateEventSource método . Você deve ter direitos administrativos no computador para criar uma nova fonte de evento.
Para obter detalhes sobre como definir mensagens de evento e criar arquivos de recursos de log de eventos, consulte o artigo Compilador de Mensagens na documentação do SDK da Plataforma.
Construtores
| EventInstance(Int64, Int32) |
Inicializa uma nova instância da classe EventInstance usando os identificadores de recurso especificados para a mensagem localizada e o texto da categoria da entrada do evento. |
| EventInstance(Int64, Int32, EventLogEntryType) |
Inicializa uma nova instância da classe EventInstance usando os identificadores de recurso especificados para a mensagem localizada e o texto da categoria da entrada do evento e o tipo de entrada de log do evento especificado. |
Propriedades
| CategoryId |
Obtém ou define o identificador de recurso que especifica a categoria definida pelo aplicativo da entrada de evento. |
| EntryType |
Obtém ou define o tipo de evento da entrada de log do evento. |
| InstanceId |
Obtém ou define o identificador de recurso que designa o texto da mensagem da entrada do evento. |
Métodos
| Equals(Object) |
Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object) |
| GetHashCode() |
Serve como a função de hash padrão. (Herdado de Object) |
| GetType() |
Obtém o Type da instância atual. (Herdado de Object) |
| MemberwiseClone() |
Cria uma cópia superficial do Object atual. (Herdado de Object) |
| ToString() |
Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object) |
Aplica-se a
Confira também
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de