EventInstance.CategoryId Właściwość
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Pobiera lub ustawia identyfikator zasobu, który określa kategorię zdefiniowaną przez aplikację wpisu zdarzenia.
public:
property int CategoryId { int get(); void set(int value); };public int CategoryId { get; set; }member this.CategoryId : int with get, setPublic Property CategoryId As IntegerWartość właściwości
Wartość kategorii liczbowej lub identyfikator zasobu, który odpowiada ciągowi zdefiniowanemu w pliku zasobu kategorii źródła zdarzeń. Wartość domyślna to zero, co oznacza, że dla wpisu zdarzenia nie będzie wyświetlana żadna kategoria.
Wyjątki
Właściwość jest ustawiona na wartość ujemną lub na wartość większą niż UInt16.MaxValue.
Przykłady
Poniższy przykład kodu zapisuje wpis zdarzenia informacyjnego, a następnie ponownie zapisuje EventInstance wpis dla zdarzenia ostrzegawczego do istniejącego dziennika zdarzeń. Tekst komunikatu o zdarzeniu jest określony przy użyciu identyfikatora zasobu w pliku zasobu komunikatu. W przykładzie kodu przyjęto założenie, że odpowiedni plik zasobu komunikatu został zarejestrowany dla źródła.
// 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
W przykładzie kodu użyto następującego pliku tekstowego wiadomości wbudowanego w bibliotekę zasobów EventLogMsgs.dll. Plik tekstowy wiadomości to źródło, z którego jest tworzony plik zasobu wiadomości. Plik tekstowy wiadomości definiuje identyfikatory zasobów i tekst dla kategorii, komunikatu o zdarzeniach i ciągów wstawiania parametrów.
; // 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
.
Uwagi
Kategorie dzienników zdarzeń to wartości zdefiniowane przez aplikację, które ułatwiają filtrowanie zdarzeń lub podają dodatkowe informacje o zdarzeniu. Na przykład aplikacja może definiować oddzielne kategorie dla różnych składników lub różnych operacji.
CategoryId Ustaw właściwość , aby określić kategorię wyświetlaną przez Podgląd zdarzeń dla wpisu. Podgląd zdarzeń może wyświetlić kategorię jako wartość liczbową lub użyć CategoryId jako identyfikatora zasobu, aby wyświetlić zlokalizowany ciąg kategorii na podstawie bieżących ustawień języka.
Aby wyświetlić zlokalizowane ciągi kategorii w Podgląd zdarzeń, należy użyć źródła zdarzeń skonfigurowanego z plikiem zasobu kategorii i ustawić CategoryId wartość na identyfikator zasobu w pliku zasobu kategorii. Jeśli źródło zdarzeń nie ma skonfigurowanego pliku zasobu kategorii lub określony CategoryId nie indeksuje ciągu w pliku zasobu kategorii, a następnie Podgląd zdarzeń wyświetla wartość kategorii liczbowej dla tego wpisu.
Przed zapisem kategorii zdarzeń przy użyciu identyfikatorów zasobów należy zarejestrować źródło w odpowiednim pliku zasobu. Skonfiguruj plik zasobu kategorii wraz z liczbą ciągów kategorii w pliku zasobu przy użyciu EventLogInstaller klasy lub EventSourceCreationData . Podczas definiowania ciągów kategorii w pliku zasobu identyfikatory zasobów kategorii muszą być numerowane kolejno od 1 do skonfigurowanej CategoryCount wartości właściwości.
Kategorie zdarzeń są opcjonalne. Jeśli aplikacja nie używa kategorii, nie należy ustawiać CategoryId wpisu dziennika zdarzeń.
Aby uzyskać szczegółowe informacje na temat definiowania komunikatów o zdarzeniach i tworzenia plików zasobów zdarzeń, zobacz artykuł Kompilator komunikatów w dokumentacji zestawu SDK platformy. Aby uzyskać szczegółowe informacje na temat definiowania kategorii zdarzeń w plikach zasobów, zobacz temat "Kategorie zdarzeń" w zestawie SDK platformy
