EventInstance.CategoryId Propriedade

Definição

Namespace:

System.Diagnostics

Assembly:

System.Diagnostics.EventLog.dll

Pacote:

System.Diagnostics.EventLog v8.0.0

Origem:

EventData.cs

Obtém ou define o identificador de recurso que especifica a categoria definida pelo aplicativo da entrada de evento.

public:
 property int CategoryId { int get(); void set(int value); };

public int CategoryId { get; set; }

member this.CategoryId : int with get, set

Public Property CategoryId As Integer

Valor da propriedade

Int32

Um valor de categoria numérica ou identificador de recurso que corresponde a uma cadeia de caracteres definida no arquivo de recurso de categoria da origem do evento. O padrão é zero, o que significa que nenhuma categoria será exibida para a entrada do evento.

Exceções

ArgumentOutOfRangeException

A propriedade é definida como um valor negativo ou como um valor maior que UInt16.MaxValue.

Exemplos

O exemplo de código a seguir grava uma entrada de evento informativo e, em seguida, 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 foi 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 arquivo de texto de mensagem a seguir, 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 inserção de categoria, mensagem de evento e parâmetro.

; // 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

As categorias de log de eventos são valores definidos pelo aplicativo que ajudam a filtrar eventos ou fornecem mais informações sobre o evento. Por exemplo, seu aplicativo pode definir categorias separadas para diferentes componentes ou operações diferentes.

Defina a CategoryId propriedade para especificar a categoria que o Visualizador de Eventos exibe para a entrada. O Visualizador de Eventos pode exibir a categoria como um valor numérico ou pode usar o CategoryId como um identificador de recurso para exibir uma cadeia de caracteres de categoria localizada com base nas configurações de idioma atuais.

Para exibir cadeias de caracteres de categoria localizadas no Visualizador de Eventos, você deve usar uma origem 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 de categoria numérica para essa entrada.

Você deve registrar a origem com o arquivo de recurso correspondente antes de gravar categorias de evento usando identificadores de recurso. 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 . Ao definir cadeias de caracteres de categoria em um arquivo de recurso, os identificadores de recurso de categoria devem ser numerados consecutivamente começando em 1, até o valor da propriedade configurada CategoryCount .

As categorias de evento são opcionais. Se o aplicativo não usar categorias, não defina o CategoryId para a entrada do log de eventos.

Para obter detalhes sobre como definir mensagens de evento e criar arquivos de recurso de evento, consulte o artigo Compilador de Mensagens na documentação do SDK da Plataforma. Para obter detalhes sobre como definir categorias de eventos em arquivos de recursos, consulte o tópico "Categorias de Eventos" no SDK da Plataforma

Confira também

• WriteEvent
• CategoryNumber
• CategoryResourceFile
• CategoryResourceFile