EventInstance.CategoryId Propriété
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Obtient ou définit l'identificateur de ressource qui spécifie la catégorie d'entrée d'événement définie par l'application.
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 IntegerValeur de propriété
Valeur de catégorie numérique ou identificateur de ressource qui correspond à une chaîne définie dans le fichier de ressources de catégorie de la source d'événements. La valeur par défaut est zéro, ce qui signifie qu'aucune catégorie ne sera affichée pour l'entrée d'événement.
Exceptions
La propriété est définie sur une valeur négative ou sur une valeur supérieure à UInt16.MaxValue.
Exemples
L’exemple de code suivant écrit une entrée d’événement d’information, puis réutilise pour EventInstance écrire une entrée pour un événement d’avertissement dans un journal des événements existant. Le texte du message d’événement est spécifié à l’aide d’un identificateur de ressource dans un fichier de ressources de message. L’exemple de code suppose que le fichier de ressources de message correspondant a été inscrit pour la source.
// 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’exemple de code utilise le fichier texte de message suivant, intégré à la bibliothèque de ressources EventLogMsgs.dll. Un fichier texte de message est la source à partir de laquelle le fichier de ressources de message est créé. Le fichier texte du message définit les identificateurs de ressource et le texte pour les chaînes d’insertion de catégorie, de message d’événement et de paramètre.
; // 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
.
Remarques
Les catégories du journal des événements sont des valeurs définies par l’application qui permettent de filtrer les événements ou fournissent des informations supplémentaires sur l’événement. Par exemple, votre application peut définir des catégories distinctes pour différents composants ou différentes opérations.
Définissez la CategoryId propriété pour spécifier la catégorie que le observateur d'événements affiche pour l’entrée. Le observateur d'événements peut afficher la catégorie sous forme de valeur numérique, ou il peut utiliser comme CategoryId identificateur de ressource pour afficher une chaîne de catégorie localisée en fonction des paramètres de langue actuels.
Pour afficher des chaînes de catégorie localisées dans le observateur d'événements, vous devez utiliser une source d’événements configurée avec un fichier de ressources de catégorie et définir sur CategoryId un identificateur de ressource dans le fichier de ressources de catégorie. Si la source d’événements n’a pas de fichier de ressources de catégorie configuré ou si le spécifié n’indexe CategoryId pas de chaîne dans le fichier de ressources de catégorie, puis le observateur d'événements affiche la valeur de catégorie numérique pour cette entrée.
Vous devez inscrire la source avec le fichier de ressources correspondant avant d’écrire des catégories d’événements à l’aide d’identificateurs de ressources. Configurez le fichier de ressources de catégorie, ainsi que le nombre de chaînes de catégorie dans le fichier de ressources, à l’aide de la EventLogInstallerEventSourceCreationData classe ou . Lors de la définition de chaînes de catégorie dans un fichier de ressources, les identificateurs de ressource de catégorie doivent être numérotés consécutivement à partir de 1, jusqu’à la valeur de la propriété configurée CategoryCount .
Les catégories d’événements sont facultatives. Si votre application n’utilise pas de catégories, ne définissez pas pour CategoryId l’entrée du journal des événements.
Pour plus d’informations sur la définition des messages d’événement et la création de fichiers de ressources d’événement, consultez l’article Compilateur de messages dans la documentation du Kit de développement logiciel (SDK) de plateforme. Pour plus d’informations sur la définition de catégories d’événements dans les fichiers de ressources, consultez la rubrique « Catégories d’événements » dans le Kit de développement logiciel (SDK) de plateforme
S’applique à
Voir aussi
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour