EventInstance.CategoryId Eigenschap

Definitie

Naamruimte:
System.Diagnostics
Assembly:
System.dll

Hiermee haalt u de resource-id op die de toepassingsgedefinieerde categorie van de gebeurtenisvermelding opgeeft of instelt.

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

Waarde van eigenschap

Int32

Een numerieke categoriewaarde of resource-id die overeenkomt met een tekenreeks die is gedefinieerd in het categorieresourcebestand van de gebeurtenisbron. De standaardwaarde is nul, waarmee wordt aangegeven dat er geen categorie wordt weergegeven voor de gebeurtenisvermelding.

Uitzonderingen

ArgumentOutOfRangeException

De eigenschap is ingesteld op een negatieve waarde of op een waarde die groter is dan UInt16.MaxValue.

Voorbeelden

In het volgende codevoorbeeld wordt een informatieve gebeurtenisvermelding geschreven en vervolgens opnieuw gebruikt EventInstance om een vermelding voor een waarschuwingsevenement naar een bestaand gebeurtenislogboek te schrijven. De tekst van het gebeurtenisbericht wordt opgegeven met behulp van een resource-id in een berichtresourcebestand. In het codevoorbeeld wordt ervan uitgegaan dat het bijbehorende berichtbronbestand is geregistreerd voor de bron.


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

In het codevoorbeeld wordt het volgende berichttekstbestand gebruikt dat is ingebouwd in de resourcebibliotheek EventLogMsgs.dll. Een berichttekstbestand is de bron van waaruit het bronbestand van het bericht wordt gemaakt. Het berichttekstbestand definieert de resource-id's en tekst voor de categorie, gebeurtenisbericht en parameterinvoegreeksen.

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

Opmerkingen

Gebeurtenislogboekcategorieën zijn toepassingsgedefinieerde waarden die helpen bij het filteren van gebeurtenissen of voor meer informatie over de gebeurtenis. Uw toepassing kan bijvoorbeeld afzonderlijke categorieën definiëren voor verschillende onderdelen of verschillende bewerkingen.

Stel de eigenschap CategoryId in om de categorie op te geven die door het Logboeken voor de vermelding wordt weergegeven. De Logboeken kan de categorie weergeven als een numerieke waarde, of de CategoryId als resource-id gebruiken om een gelokaliseerde categorietekenreeks weer te geven op basis van de huidige taalinstellingen.

Als u gelokaliseerde categorietekenreeksen wilt weergeven in de Logboeken, moet u een gebeurtenisbron gebruiken die is geconfigureerd met een categorieresourcebestand en de CategoryId instellen op een resource-id in het categorieresourcebestand. Als de gebeurtenisbron geen geconfigureerd categorieresourcebestand heeft of als de opgegeven CategoryId geen tekenreeks indexeren in het resourcebestand van de categorie en vervolgens wordt in het Logboeken de numerieke categoriewaarde voor die vermelding weergegeven.

U moet de bron registreren bij het bijbehorende resourcebestand voordat u gebeurteniscategorieën schrijft met behulp van resource-id's. Configureer het categorieresourcebestand, samen met het aantal categorietekenreeksen in het resourcebestand, met behulp van de EventLogInstaller of de EventSourceCreationData klasse. Wanneer u categorietekenreeksen in een resourcebestand definieert, moeten de resource-id's van de categorie opeenvolgend worden genummerd vanaf 1, tot aan de geconfigureerde CategoryCount eigenschapswaarde.

Gebeurteniscategorieën zijn optioneel. Als uw toepassing geen categorieën gebruikt, moet u deze CategoryId niet instellen voor de vermelding van het gebeurtenislogboek.

Zie het artikel Message Compiler in de Platform SDK-documentatie voor meer informatie over het definiëren van gebeurtenisberichten en het bouwen van gebeurtenisresourcebestanden. Zie het onderwerp Gebeurteniscategorieën in de Platform-SDK voor meer informatie over het definiëren van gebeurteniscategorieën in resourcebestanden

Van toepassing op

Zie ook