EventInstance.InstanceId Propriedade
Definição
Obtém ou define o identificador de recurso que designa o texto da mensagem da entrada do evento.Gets or sets the resource identifier that designates the message text of the event entry.
public:
property long InstanceId { long get(); void set(long value); };
public long InstanceId { get; set; }
member this.InstanceId : int64 with get, set
Public Property InstanceId As Long
Valor da propriedade
Um identificador de recurso que corresponde a uma cadeia de caracteres definida no arquivo de recurso da mensagem da origem do evento.A resource identifier that corresponds to a string defined in the message resource file of the event source.
Exceções
A propriedade está definida com um valor negativo ou um valor maior que MaxValue.The property is set to a negative value or to a value larger than MaxValue.
Exemplos
O exemplo de código a seguir grava uma entrada de evento informativo e, em seguida, reutiliza o EventInstance para gravar uma entrada para um evento de aviso em um log de eventos existente.The following code example writes an informational event entry, and then reuses the EventInstance to write an entry for a warning event to an existing event log. O texto da mensagem do evento é especificado usando um identificador de recurso em um arquivo de recurso de mensagem.The event message text is specified using a resource identifier in a message resource file. O exemplo de código supõe que o arquivo de recurso de mensagem correspondente foi registrado para a origem.The code example assumes that the corresponding message resource file has been registered for the 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
O exemplo de código usa o seguinte arquivo de texto de mensagem, interno à biblioteca de recursos EventLogMsgs.dll.The code example uses the following message text file, built into the resource library EventLogMsgs.dll. Um arquivo de texto de mensagem é a origem da qual o arquivo de recurso de mensagem é criado.A message text file is the source from which the message resource file is created. O arquivo de texto da mensagem define os identificadores de recurso e o texto para a categoria, a mensagem de evento e as cadeias de caracteres de inserção de parâmetro.The message text file defines the resource identifiers and text for the category, event message, and parameter insertion strings.
; // 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
.
Comentários
A InstanceId propriedade identifica exclusivamente uma entrada de evento para uma origem de evento configurada.The InstanceId property uniquely identifies an event entry for a configured event source. Para eventos definidos em arquivos de recurso de mensagem, o InstanceId corresponde ao identificador de recurso compilado dos campos de definição de mensagem no arquivo de texto da mensagem.For events defined in message resource files, the InstanceId corresponds to the resource identifier compiled from the message definition fields in the message text file. Seu aplicativo pode gravar entradas localizadas do log de eventos definindo o InstanceId para um identificador de recurso.Your application can write localized event log entries by setting the InstanceId to a resource identifier. O Visualizador de Eventos usa o InstanceId identificador de recurso para localizar e exibir a cadeia de caracteres correspondente do arquivo de recursos localizado com base nas configurações de idioma atuais.The Event Viewer uses the InstanceId resource identifier to find and display the corresponding string from the localized resource file based on current language settings. Você deve registrar a origem com o arquivo de recurso correspondente antes de gravar eventos usando identificadores de recursos.You must register the source with the corresponding resource file before you write events using resource identifiers.
Para obter detalhes sobre como definir mensagens de evento e criar arquivos de recursos de log de eventos, consulte o artigo do compilador de mensagens na documentação do Platform SDK.For details about defining event messages and building event log resource files, see the Message Compiler article in the Platform SDK documentation. Para obter detalhes sobre identificadores de log de eventos, consulte o artigo identificadores de evento na documentação do Platform SDK.For details about event log identifiers, see the Event Identifiers article in the Platform SDK documentation.