EventInstance.CategoryId Proprietà

Definizione

Spazio dei nomi:

System.Diagnostics

Assembly:

System.Diagnostics.EventLog.dll

Pacchetto:

System.Diagnostics.EventLog v8.0.0

Source:

EventData.cs

Ottiene o imposta l'identificatore di risorsa che specifica la categoria definita dall'applicazione della voce dell'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

Valore della proprietà

Int32

Un valore numerico di categoria o un identificatore di risorsa che corrisponde a una stringa definita nel file di risorse della categoria dell'origine eventi. Il valore predefinito è zero, che significa che per la voce dell'evento non verrà visualizzata alcuna categoria.

Eccezioni

ArgumentOutOfRangeException

La proprietà è impostata su un valore negativo o su un valore maggiore di UInt16.MaxValue.

Esempio

Nell'esempio EventInstance di codice seguente viene scritta una voce di evento informativo e quindi viene riutilizzata per scrivere una voce per un evento di avviso in un registro eventi esistente. Il testo del messaggio di evento viene specificato usando un identificatore di risorsa in un file di risorse del messaggio. L'esempio di codice presuppone che il file di risorse del messaggio corrispondente sia stato registrato per l'origine.

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

L'esempio di codice usa il file di testo del messaggio seguente, integrato nella libreria di risorse EventLogMsgs.dll. Un file di testo del messaggio è l'origine da cui viene creato il file di risorse del messaggio. Il file di testo del messaggio definisce gli identificatori di risorsa e il testo per la categoria, il messaggio di evento e le stringhe di inserimento dei parametri.

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

Commenti

Le categorie di log eventi sono valori definiti dall'applicazione che consentono di filtrare gli eventi o fornire ulteriori informazioni sull'evento. Ad esempio, l'applicazione può definire categorie separate per componenti diversi o operazioni diverse.

Impostare la CategoryId proprietà per specificare la categoria visualizzata dall'Visualizzatore eventi per la voce. Il Visualizzatore eventi può visualizzare la categoria come valore numerico oppure può usare come CategoryId identificatore di risorsa per visualizzare una stringa di categoria localizzata in base alle impostazioni della lingua corrente.

Per visualizzare le stringhe di categoria localizzate nella Visualizzatore eventi, è necessario usare un'origine evento configurata con un file di risorse di categoria e impostare su CategoryId un identificatore di risorsa nel file di risorse di categoria. Se l'origine evento non dispone di un file di risorse di categoria configurato oppure l'oggetto specificato CategoryId non indicizza una stringa nel file di risorse di categoria e quindi il Visualizzatore eventi visualizza il valore della categoria numerica per tale voce.

È necessario registrare l'origine con il file di risorse corrispondente prima di scrivere categorie di eventi usando identificatori di risorsa. Configurare il file di risorse di categoria, insieme al numero di stringhe di categoria nel file di risorse, usando o EventLogInstaller la EventSourceCreationData classe . Quando si definiscono le stringhe di categoria in un file di risorse, gli identificatori di risorsa categoria devono essere numerati consecutivamente a partire da 1, fino al valore della proprietà configurato CategoryCount .

Le categorie di eventi sono facoltative. Se l'applicazione non usa le categorie, non impostare l'oggetto CategoryId per la voce del registro eventi.

Per informazioni dettagliate sulla definizione di messaggi di evento e sulla creazione di file di risorse evento, vedere l'articolo Del compilatore di messaggi nella documentazione di Platform SDK. Per informazioni dettagliate sulla definizione di categorie di eventi nei file di risorse, vedere l'argomento "Categorie di eventi" in Platform SDK

Vedi anche

• WriteEvent
• CategoryNumber
• CategoryResourceFile
• CategoryResourceFile