EventInstance Classe
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.
Représente des informations indépendantes du langage pour une entrée du journal des événements.
public ref class EventInstancepublic class EventInstancetype EventInstance = classPublic Class EventInstance- Héritage
-
EventInstance
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
Utilisez EventInstance pour écrire une entrée de journal des événements avec un identificateur de ressource plutôt qu’une valeur de chaîne. Pour écrire une entrée de journal des événements, initialisez la InstanceId propriété et passez le instance à la WriteEvent méthode . Le observateur d'événements utilise l’identificateur instance pour rechercher et afficher la chaîne correspondante à partir du fichier de ressources localisé en fonction des paramètres de langue actuels. Vous devez inscrire la source d’événement avec le fichier de ressources correspondant avant d’écrire des événements à l’aide d’identificateurs de ressource.
Lors de l’écriture d’événements, vous pouvez définir la EntryType propriété pour spécifier l’icône que le observateur d'événements affiche pour l’entrée. Vous pouvez également spécifier une 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 utilise la catégorie pour filtrer les événements écrits par une source d’événement. Le observateur d'événements peut afficher la catégorie sous forme de valeur numérique ou utiliser la catégorie comme identificateur de ressource pour afficher une chaîne de catégorie localisée.
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. 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 .
Vous devez inscrire une source pour un journal des événements avant d’utiliser EventInstance pour écrire un événement avec la WriteEvent méthode . La source doit être configurée pour écrire des entrées localisées dans le journal et la source doit définir au moins un fichier de ressources de message.
Create la nouvelle source d’événement pendant l’installation de votre application. Cela laisse le temps au système d’exploitation d’actualiser sa liste des sources d’événements inscrites et leurs configurations. Si le système d’exploitation n’a pas actualisé sa liste de sources d’événements et que vous tentez d’écrire un événement avec la nouvelle source, l’opération d’écriture échoue. Vous pouvez configurer une nouvelle source à l’aide d’une EventLogInstaller, ou à l’aide de la CreateEventSource méthode . Vous devez disposer de droits d’administration sur l’ordinateur pour créer une source d’événement.
Pour plus d’informations sur la définition des messages d’événements et la création de fichiers de ressources du journal des événements, consultez l’article Compilateur de messages dans la documentation du Kit de développement logiciel (SDK) de plateforme.
Constructeurs
| EventInstance(Int64, Int32) |
Initialise une nouvelle instance de la classe EventInstance à l'aide des identificateurs de ressource spécifiés pour le message localisé et le texte de catégorie de l'entrée d'événement. |
| EventInstance(Int64, Int32, EventLogEntryType) |
Initialise une nouvelle instance de la classe EventInstance à l'aide des identificateurs de ressource spécifiés pour le message localisé, le texte de catégorie de l'entrée d'événement et le type d'entrée du journal des événements spécifié. |
Propriétés
| CategoryId |
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. |
| EntryType |
Obtient ou définit le type d'événement de l'entrée du journal des événements. |
| InstanceId |
Obtient ou définit l'identificateur de ressource qui désigne le texte du message de l'entrée d'événement. |
Méthodes
| Equals(Object) |
Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object) |
| GetHashCode() |
Fait office de fonction de hachage par défaut. (Hérité de Object) |
| GetType() |
Obtient le Type de l'instance actuelle. (Hérité de Object) |
| MemberwiseClone() |
Crée une copie superficielle du Object actuel. (Hérité de Object) |
| ToString() |
Retourne une chaîne qui représente l'objet actuel. (Hérité de Object) |
