Compartilhar via

EventLog.WriteEvent Método

  • Referência

Definição

Namespace:
System.Diagnostics
Assembly:
System.Diagnostics.EventLog.dll
Assembly:
System.dll
Pacote:
System.Diagnostics.EventLog v6.0.0
Pacote:
System.Diagnostics.EventLog v7.0.0
Pacote:
System.Diagnostics.EventLog v8.0.0
Pacote:
System.Diagnostics.EventLog v9.0.0-preview.2.24128.5

Grava uma entrada de evento localizada no log de eventos.

Sobrecargas

WriteEvent(String, EventInstance, Object[])

Grava uma entrada de log de eventos com os dados do evento e as cadeias de caracteres de substituição de mensagem, usando a origem de evento registrada especificada.
WriteEvent(EventInstance, Object[])

Grava uma entrada localizada no log de eventos.
WriteEvent(EventInstance, Byte[], Object[])

Grava uma entrada de log de eventos com os dados de evento, cadeias de caracteres de substituição de mensagem e os dados binários associados.
WriteEvent(String, EventInstance, Byte[], Object[])

Grava uma entrada de log de eventos com os dados de evento, cadeias de caracteres de substituição de mensagem e os dados binários associados e usando a origem do evento registrada especificada.

WriteEvent(String, EventInstance, Object[])

Origem:
EventLog.cs
Origem:
EventLog.cs
Origem:
EventLog.cs

Grava uma entrada de log de eventos com os dados do evento e as cadeias de caracteres de substituição de mensagem, usando a origem de evento registrada especificada.

public:
 static void WriteEvent(System::String ^ source, System::Diagnostics::EventInstance ^ instance, ... cli::array <System::Object ^> ^ values);
public static void WriteEvent (string source, System.Diagnostics.EventInstance instance, params object[] values);
static member WriteEvent : string * System.Diagnostics.EventInstance * obj[] -> unit
Public Shared Sub WriteEvent (source As String, instance As EventInstance, ParamArray values As Object())

Parâmetros

source
String

O nome da origem de evento registrada para o aplicativo no computador especificado.

instance
EventInstance

Uma instância EventInstance que representa uma entrada de log de eventos localizada.

values
Object[]

Uma matriz de cadeias de caracteres para mesclar o texto da mensagem da entrada de log de eventos.

Exceções

ArgumentException

O valor source é uma cadeia de caracteres vazia ("").

- ou -

O valor source é null.

- ou -

instance.InstanceId é menor que zero ou maior que UInt16.MaxValue.

- ou -

values tem mais de 256 elementos.

- ou -

Um dos elementos values é maior que 32766 bytes.

- ou -

O nome da origem resulta em um caminho de chave do Registro com mais de 254 caracteres.

ArgumentNullException

instance é null.

InvalidOperationException

Não foi possível abrir a chave do Registro para o log de eventos.

Win32Exception

O sistema operacional relatou um erro ao gravar a entrada de evento no log de eventos. Um código de erro do Windows não está disponível.

Exemplos

O exemplo a seguir grava uma entrada de evento informativo e uma entrada de evento de aviso em um log de eventos existente. O texto da mensagem de evento é especificado usando um identificador de recurso em um arquivo de recurso. O exemplo pressupõe que o arquivo de recurso correspondente foi registrado para a origem.

String^ sourceName = "SampleApplicationSource";
if ( EventLog::SourceExists( sourceName ) )
{
   
   // Define an informational event and a warning event.
   // The message identifiers correspond to the message text in the
   // message resource file defined for the source.
   EventInstance ^ myInfoEvent = gcnew EventInstance( InformationMsgId,0,EventLogEntryType::Information );
   EventInstance ^ myWarningEvent = gcnew EventInstance( WarningMsgId,0,EventLogEntryType::Warning );
   
   // Insert the method name into the event log message.
   array<String^>^insertStrings = {"EventLogSamples.WriteEventSample2"};
   
   // Write the events to the event log.
   EventLog::WriteEvent( sourceName, myInfoEvent, 0 );
   
   // Append binary data to the warning event entry.
   array<Byte>^binaryData = {7,8,9,10};
   EventLog::WriteEvent( sourceName, myWarningEvent, binaryData, insertStrings );
}
else
{
   Console::WriteLine( "Warning - event source {0} not registered", sourceName );
}


string sourceName = "SampleApplicationSource";
if(EventLog.SourceExists(sourceName))
{

    // Define an informational event and a warning event.

    // The message identifiers correspond to the message text in the
    // message resource file defined for the source.
    EventInstance myInfoEvent = new EventInstance(InformationMsgId, 0, EventLogEntryType.Information);
    EventInstance myWarningEvent = new EventInstance(WarningMsgId, 0, EventLogEntryType.Warning);

    // Insert the method name into the event log message.
    string [] insertStrings = {"EventLogSamples.WriteEventSample2"};

    // Write the events to the event log.

    EventLog.WriteEvent(sourceName, myInfoEvent);

    // Append binary data to the warning event entry.
    byte [] binaryData = { 7, 8, 9, 10 };
    EventLog.WriteEvent(sourceName, myWarningEvent, binaryData, insertStrings);
}
else
{
    Console.WriteLine("Warning - event source {0} not registered",
        sourceName);
}

           Dim sourceName As String = "SampleApplicationSource"
           If EventLog.SourceExists(sourceName)
  
               ' Define an informational event and a warning event.

               ' The message identifiers correspond to the message text in the
               ' message resource file defined for the source.
               Dim myInfoEvent As EventInstance = new EventInstance(InformationMsgId, 0, EventLogEntryType.Information)
               Dim myWarningEvent As EventInstance = new EventInstance(WarningMsgId, 0, EventLogEntryType.Warning)

               ' Insert the method name into the event log message.
               Dim insertStrings() As String = {"EventLogSamples.WriteEventSample2"}
           
               ' Write the events to the event log.

               EventLog.WriteEvent(sourceName, myInfoEvent, insertStrings)

               ' Append binary data to the warning event entry.
               Dim binaryData() As Byte = { 7, 8, 9, 10 }
               EventLog.WriteEvent(sourceName, myWarningEvent, binaryData, insertStrings)
           Else 
               Console.WriteLine("Warning - event source {0} not registered", _
                   sourceName)
           End If

O exemplo usa o arquivo de texto de mensagem a seguir, integrado à biblioteca de recursos EventLogMsgs.dll. Um arquivo de texto de mensagem é a origem da qual o arquivo de recurso de mensagem é criado. O arquivo de texto da mensagem define os identificadores de recurso e o texto para as cadeias de caracteres de inserção de categoria, mensagem de evento e parâmetro.

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

Use esse método para gravar uma entrada localizada no log de eventos, usando uma origem já registrada como uma origem do evento para o log apropriado. Especifique as propriedades do evento com identificadores de recurso em vez de valores de cadeia de caracteres. O Visualizador de Eventos usa os identificadores de recurso para exibir as cadeias de caracteres correspondentes do arquivo de recurso localizado para a origem. Você deve registrar a origem com o arquivo de recurso correspondente antes de gravar eventos usando identificadores de recurso.

A instância de entrada instance especifica a mensagem de evento e as propriedades. Defina o InstanceId da instance entrada para a mensagem definida no arquivo de recurso de mensagem de origem. Opcionalmente, você pode definir o CategoryId e EntryType da instance entrada para definir a categoria e o tipo de evento de sua entrada de evento. Você também pode especificar uma matriz de cadeias de caracteres independentes de idioma para inserir no texto da mensagem localizada. Defina values como null se a mensagem de evento não contiver espaços reservados de formatação para cadeias de caracteres de substituição.

A origem especificada deve ser registrada para um log de eventos antes de usar WriteEvent. A origem especificada deve ser configurada para gravar entradas localizadas no log; a origem deve, no mínimo, ter um arquivo de recurso de mensagem definido.

Você deve criar e configurar a origem do evento antes de gravar a primeira entrada com a origem. Create a nova origem do evento durante a instalação do aplicativo. Isso permite que o sistema operacional atualize sua lista de fontes de eventos registradas e sua configuração. Se o sistema operacional não tiver atualizado sua lista de fontes de eventos e você tentar gravar um evento com a nova origem, a operação de gravação falhará. Você pode configurar uma nova fonte usando um EventLogInstallerou usando o CreateEventSource método . Você deve ter direitos administrativos no computador para criar uma nova origem do evento.

A origem deve ser configurada para gravar entradas localizadas ou para gravar cadeias de caracteres diretas. Use o método se o WriteEntry aplicativo gravar valores de cadeia de caracteres diretamente no log de eventos.

Se o aplicativo gravar entradas usando identificadores de recurso e valores de cadeia de caracteres, você deverá registrar duas fontes separadas. Por exemplo, configure uma fonte com arquivos de recurso e, em seguida, use essa origem WriteEvent no método para gravar entradas usando identificadores de recurso no log de eventos. Em seguida, crie uma fonte diferente sem arquivos de recurso e use essa origem WriteEntry no método para gravar cadeias de caracteres diretamente no log de eventos usando essa origem.

Confira também

Aplica-se a

WriteEvent(EventInstance, Object[])

Origem:
EventLog.cs
Origem:
EventLog.cs
Origem:
EventLog.cs

Grava uma entrada localizada no log de eventos.

public:
 void WriteEvent(System::Diagnostics::EventInstance ^ instance, ... cli::array <System::Object ^> ^ values);
public void WriteEvent (System.Diagnostics.EventInstance instance, params object[] values);
[System.Runtime.InteropServices.ComVisible(false)]
public void WriteEvent (System.Diagnostics.EventInstance instance, params object[] values);
member this.WriteEvent : System.Diagnostics.EventInstance * obj[] -> unit
[<System.Runtime.InteropServices.ComVisible(false)>]
member this.WriteEvent : System.Diagnostics.EventInstance * obj[] -> unit
Public Sub WriteEvent (instance As EventInstance, ParamArray values As Object())

Parâmetros

instance
EventInstance

Uma instância EventInstance que representa uma entrada de log de eventos localizada.

values
Object[]

Uma matriz de cadeias de caracteres para mesclar o texto da mensagem da entrada de log de eventos.

Atributos
ComVisibleAttribute

Exceções

ArgumentException

A propriedade Source do EventLog não foi definida.

- ou -

O método tentou registrar uma nova fonte de evento, mas o nome do computador em MachineName não é válido.

- ou -

A origem já está registrada para um log de eventos diferente.

- ou -

instance.InstanceId é menor que zero ou maior que UInt16.MaxValue.

- ou -

values tem mais de 256 elementos.

- ou -

Um dos elementos values é maior que 32766 bytes.

- ou -

O nome da origem resulta em um caminho de chave do Registro com mais de 254 caracteres.

ArgumentNullException

instance é null.

InvalidOperationException

Não foi possível abrir a chave do Registro para o log de eventos.

Win32Exception

O sistema operacional relatou um erro ao gravar a entrada de evento no log de eventos. Um código de erro do Windows não está disponível.

Exemplos

O exemplo a seguir grava duas entradas de auditoria no log de eventos myNewLog. O exemplo cria uma nova origem do evento e um novo log de eventos se eles não existirem no computador local. O texto da mensagem de evento é especificado usando um identificador de recurso em um arquivo de recurso.

// Create the event source if it does not exist.
String^ sourceName = "SampleApplicationSource";
if (  !EventLog::SourceExists( sourceName ) )
{
   
   // Call a local method to register the event log source
   // for the event log "myNewLog."  Use the resource file
   // EventLogMsgs.dll in the current directory for message text.
   String^ messageFile = String::Format( "{0}\\{1}", System::Environment::CurrentDirectory, "EventLogMsgs.dll" );
   CreateEventSourceSample1( messageFile );
}

// Get the event log corresponding to the existing source.
String^ myLogName = EventLog::LogNameFromSourceName( sourceName, "." );
EventLog^ myEventLog = gcnew EventLog( myLogName,".",sourceName );

// Define two audit events.
// The message identifiers correspond to the message text in the
// message resource file defined for the source.
EventInstance ^ myAuditSuccessEvent = gcnew EventInstance( AuditSuccessMsgId,0,EventLogEntryType::SuccessAudit );
EventInstance ^ myAuditFailEvent = gcnew EventInstance( AuditFailedMsgId,0,EventLogEntryType::FailureAudit );

// Insert the method name into the event log message.
array<String^>^insertStrings = {"EventLogSamples.WriteEventSample1"};

// Write the events to the event log.
myEventLog->WriteEvent( myAuditSuccessEvent, insertStrings );

// Append binary data to the audit failure event entry.
array<Byte>^binaryData = {3,4,5,6};
myEventLog->WriteEvent( myAuditFailEvent, binaryData, insertStrings );


// Create the event source if it does not exist.
string sourceName = "SampleApplicationSource";
if(!EventLog.SourceExists(sourceName))
{
    // Call a local method to register the event log source
    // for the event log "myNewLog."  Use the resource file
    // EventLogMsgs.dll in the current directory for message text.

    string messageFile =  String.Format("{0}\\{1}",
        System.Environment.CurrentDirectory,
        "EventLogMsgs.dll");

    CreateEventSourceSample1(messageFile);
}

// Get the event log corresponding to the existing source.
string myLogName = EventLog.LogNameFromSourceName(sourceName,".");

EventLog myEventLog = new EventLog(myLogName, ".", sourceName);

// Define two audit events.

// The message identifiers correspond to the message text in the
// message resource file defined for the source.
EventInstance myAuditSuccessEvent = new EventInstance(AuditSuccessMsgId, 0, EventLogEntryType.SuccessAudit);
EventInstance myAuditFailEvent = new EventInstance(AuditFailedMsgId, 0, EventLogEntryType.FailureAudit);

// Insert the method name into the event log message.
string [] insertStrings = {"EventLogSamples.WriteEventSample1"};

// Write the events to the event log.

myEventLog.WriteEvent(myAuditSuccessEvent, insertStrings);

// Append binary data to the audit failure event entry.
byte [] binaryData = { 3, 4, 5, 6 };
myEventLog.WriteEvent(myAuditFailEvent, binaryData, insertStrings);


           Dim sourceName As String = "SampleApplicationSource"

           ' Create the event source if it does not exist.
           If Not EventLog.SourceExists(sourceName)
  
               ' Call a local method to register the event log source
               ' for the event log "myNewLog."  Use the resource file
               ' EventLogMsgs.dll in the current directory for message text.

               Dim messageFile As String =  String.Format("{0}\\{1}", _
                   System.Environment.CurrentDirectory, _
                   "EventLogMsgs.dll")

               CreateEventSourceSample1(messageFile)
           End If 

           ' Get the event log corresponding to the existing source.
           Dim myLogName As String = EventLog.LogNameFromSourceName(sourceName,".")
       
           Dim myEventLog As EventLog = new EventLog(myLogName, ".", sourceName)

           ' Define two audit events.
           Dim myAuditSuccessEvent As EventInstance = new EventInstance(AuditSuccessMsgId, 0, EventLogEntryType.SuccessAudit)
           Dim myAuditFailEvent As EventInstance = new EventInstance(AuditFailedMsgId, 0, EventLogEntryType.FailureAudit)

           ' Insert the method name into the event log message.
           Dim insertStrings() As String = {"EventLogSamples.WriteEventSample1"}
           
           ' Write the events to the event log.

           myEventLog.WriteEvent(myAuditSuccessEvent, insertStrings)

           ' Append binary data to the audit failure event entry.
           Dim binaryData() As Byte = { 7, 8, 9, 10 }
           myEventLog.WriteEvent(myAuditFailEvent, binaryData, insertStrings)

O exemplo usa o arquivo de texto de mensagem a seguir, integrado à biblioteca de recursos EventLogMsgs.dll. Um arquivo de texto de mensagem é a origem da qual o arquivo de recurso de mensagem é criado. O arquivo de texto da mensagem define os identificadores de recurso e o texto para as cadeias de caracteres de inserção de categoria, mensagem de evento e parâmetro.

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

Use esse método para gravar uma entrada localizada no log de eventos. Especifique as propriedades do evento com identificadores de recurso em vez de valores de cadeia de caracteres. O Visualizador de Eventos usa os identificadores de recurso para exibir as cadeias de caracteres correspondentes do arquivo de recurso localizado para o Source. Você deve registrar a origem com o arquivo de recurso correspondente antes de gravar eventos usando identificadores de recurso.

A instância de entrada instance especifica a mensagem de evento e as propriedades. Defina o InstanceId da instance entrada para a mensagem definida no arquivo de recurso de mensagem de origem. Opcionalmente, você pode definir o CategoryId e EntryType da instance entrada para definir a categoria e o tipo de evento de sua entrada de evento. Você também pode especificar uma matriz de cadeias de caracteres independentes de idioma para inserir no texto da mensagem localizada. Defina values como null se a mensagem de evento não contiver espaços reservados de formatação para cadeias de caracteres de substituição.

Você deve definir a Source propriedade em seu EventLog componente antes de usar WriteEvent. A origem especificada deve ser configurada para gravar entradas localizadas no log; a origem deve, no mínimo, ter um arquivo de recurso de mensagem definido.

Você deve criar e configurar a origem do evento antes de gravar a primeira entrada com a origem. Create a nova origem do evento durante a instalação do aplicativo. Isso permite que o sistema operacional atualize sua lista de fontes de eventos registradas e sua configuração. Se o sistema operacional não tiver atualizado sua lista de fontes de eventos e você tentar gravar um evento com a nova origem, a operação de gravação falhará. Você pode configurar uma nova fonte usando um EventLogInstallerou usando o CreateEventSource método . Você deve ter direitos administrativos no computador para criar uma nova fonte de evento.

A origem deve ser configurada para gravar entradas localizadas ou para gravar cadeias de caracteres diretas. Use o método se o WriteEntry aplicativo gravar valores de cadeia de caracteres diretamente no log de eventos.

Se o aplicativo gravar entradas usando identificadores de recurso e valores de cadeia de caracteres, você deverá registrar duas fontes separadas. Por exemplo, configure uma fonte com arquivos de recurso e use essa origem WriteEvent no método para gravar entradas usando identificadores de recurso no log de eventos. Em seguida, crie uma fonte diferente sem arquivos de recurso e use essa origem WriteEntry no método para gravar cadeias de caracteres diretamente no log de eventos usando essa origem.

Observação

Se você gravar uma entrada em um computador remoto, o valor da cadeia de message caracteres poderá não ser o esperado se o computador remoto não estiver executando o .NET Framework. Além disso, a message cadeia de caracteres não pode conter %n, em que n é um valor inteiro (por exemplo, %1), porque o visualizador de eventos a trata como uma cadeia de caracteres de inserção. Como um protocolo da Internet, o endereço IPv6 (versão 6) pode conter essa sequência de caracteres, você não pode registrar uma mensagem de evento que contenha um endereço IPv6.

Confira também

Aplica-se a

WriteEvent(EventInstance, Byte[], Object[])

Origem:
EventLog.cs
Origem:
EventLog.cs
Origem:
EventLog.cs

Grava uma entrada de log de eventos com os dados de evento, cadeias de caracteres de substituição de mensagem e os dados binários associados.

public:
 void WriteEvent(System::Diagnostics::EventInstance ^ instance, cli::array <System::Byte> ^ data, ... cli::array <System::Object ^> ^ values);
public void WriteEvent (System.Diagnostics.EventInstance instance, byte[] data, params object[] values);
[System.Runtime.InteropServices.ComVisible(false)]
public void WriteEvent (System.Diagnostics.EventInstance instance, byte[] data, params object[] values);
member this.WriteEvent : System.Diagnostics.EventInstance * byte[] * obj[] -> unit
[<System.Runtime.InteropServices.ComVisible(false)>]
member this.WriteEvent : System.Diagnostics.EventInstance * byte[] * obj[] -> unit
Public Sub WriteEvent (instance As EventInstance, data As Byte(), ParamArray values As Object())

Parâmetros

instance
EventInstance

Uma instância EventInstance que representa uma entrada de log de eventos localizada.

data
Byte[]

Uma matriz de bytes que contém os dados binários associados à entrada.

values
Object[]

Uma matriz de cadeias de caracteres para mesclar o texto da mensagem da entrada de log de eventos.

Atributos
ComVisibleAttribute

Exceções

ArgumentException

A propriedade Source do EventLog não foi definida.

- ou -

O método tentou registrar uma nova fonte de evento, mas o nome do computador em MachineName não é válido.

- ou -

A origem já está registrada para um log de eventos diferente.

- ou -

instance.InstanceId é menor que zero ou maior que UInt16.MaxValue.

- ou -

values tem mais de 256 elementos.

- ou -

Um dos elementos values é maior que 32766 bytes.

- ou -

O nome da origem resulta em um caminho de chave do Registro com mais de 254 caracteres.

ArgumentNullException

instance é null.

InvalidOperationException

Não foi possível abrir a chave do Registro para o log de eventos.

Win32Exception

O sistema operacional relatou um erro ao gravar a entrada de evento no log de eventos. Um código de erro do Windows não está disponível.

Exemplos

O exemplo a seguir grava duas entradas de auditoria no log de eventos myNewLog. O exemplo cria uma nova fonte de evento e um novo log de eventos se eles não existirem no computador local. O texto da mensagem de evento é especificado usando um identificador de recurso em um arquivo de recurso.

// Create the event source if it does not exist.
String^ sourceName = "SampleApplicationSource";
if (  !EventLog::SourceExists( sourceName ) )
{
   
   // Call a local method to register the event log source
   // for the event log "myNewLog."  Use the resource file
   // EventLogMsgs.dll in the current directory for message text.
   String^ messageFile = String::Format( "{0}\\{1}", System::Environment::CurrentDirectory, "EventLogMsgs.dll" );
   CreateEventSourceSample1( messageFile );
}

// Get the event log corresponding to the existing source.
String^ myLogName = EventLog::LogNameFromSourceName( sourceName, "." );
EventLog^ myEventLog = gcnew EventLog( myLogName,".",sourceName );

// Define two audit events.
// The message identifiers correspond to the message text in the
// message resource file defined for the source.
EventInstance ^ myAuditSuccessEvent = gcnew EventInstance( AuditSuccessMsgId,0,EventLogEntryType::SuccessAudit );
EventInstance ^ myAuditFailEvent = gcnew EventInstance( AuditFailedMsgId,0,EventLogEntryType::FailureAudit );

// Insert the method name into the event log message.
array<String^>^insertStrings = {"EventLogSamples.WriteEventSample1"};

// Write the events to the event log.
myEventLog->WriteEvent( myAuditSuccessEvent, insertStrings );

// Append binary data to the audit failure event entry.
array<Byte>^binaryData = {3,4,5,6};
myEventLog->WriteEvent( myAuditFailEvent, binaryData, insertStrings );


// Create the event source if it does not exist.
string sourceName = "SampleApplicationSource";
if(!EventLog.SourceExists(sourceName))
{
    // Call a local method to register the event log source
    // for the event log "myNewLog."  Use the resource file
    // EventLogMsgs.dll in the current directory for message text.

    string messageFile =  String.Format("{0}\\{1}",
        System.Environment.CurrentDirectory,
        "EventLogMsgs.dll");

    CreateEventSourceSample1(messageFile);
}

// Get the event log corresponding to the existing source.
string myLogName = EventLog.LogNameFromSourceName(sourceName,".");

EventLog myEventLog = new EventLog(myLogName, ".", sourceName);

// Define two audit events.

// The message identifiers correspond to the message text in the
// message resource file defined for the source.
EventInstance myAuditSuccessEvent = new EventInstance(AuditSuccessMsgId, 0, EventLogEntryType.SuccessAudit);
EventInstance myAuditFailEvent = new EventInstance(AuditFailedMsgId, 0, EventLogEntryType.FailureAudit);

// Insert the method name into the event log message.
string [] insertStrings = {"EventLogSamples.WriteEventSample1"};

// Write the events to the event log.

myEventLog.WriteEvent(myAuditSuccessEvent, insertStrings);

// Append binary data to the audit failure event entry.
byte [] binaryData = { 3, 4, 5, 6 };
myEventLog.WriteEvent(myAuditFailEvent, binaryData, insertStrings);


           Dim sourceName As String = "SampleApplicationSource"

           ' Create the event source if it does not exist.
           If Not EventLog.SourceExists(sourceName)
  
               ' Call a local method to register the event log source
               ' for the event log "myNewLog."  Use the resource file
               ' EventLogMsgs.dll in the current directory for message text.

               Dim messageFile As String =  String.Format("{0}\\{1}", _
                   System.Environment.CurrentDirectory, _
                   "EventLogMsgs.dll")

               CreateEventSourceSample1(messageFile)
           End If 

           ' Get the event log corresponding to the existing source.
           Dim myLogName As String = EventLog.LogNameFromSourceName(sourceName,".")
       
           Dim myEventLog As EventLog = new EventLog(myLogName, ".", sourceName)

           ' Define two audit events.
           Dim myAuditSuccessEvent As EventInstance = new EventInstance(AuditSuccessMsgId, 0, EventLogEntryType.SuccessAudit)
           Dim myAuditFailEvent As EventInstance = new EventInstance(AuditFailedMsgId, 0, EventLogEntryType.FailureAudit)

           ' Insert the method name into the event log message.
           Dim insertStrings() As String = {"EventLogSamples.WriteEventSample1"}
           
           ' Write the events to the event log.

           myEventLog.WriteEvent(myAuditSuccessEvent, insertStrings)

           ' Append binary data to the audit failure event entry.
           Dim binaryData() As Byte = { 7, 8, 9, 10 }
           myEventLog.WriteEvent(myAuditFailEvent, binaryData, insertStrings)

O exemplo usa o seguinte arquivo de texto de mensagem, integrado à biblioteca de recursos EventLogMsgs.dll. Um arquivo de texto de mensagem é a origem da qual o arquivo de recurso de mensagem é criado. O arquivo de texto da mensagem define os identificadores de recurso e o texto para as cadeias de caracteres de categoria, mensagem de evento e inserção de parâmetros.

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

Use esse método para gravar uma entrada localizada com dados adicionais específicos do evento no log de eventos. Especifique as propriedades do evento com identificadores de recurso em vez de valores de cadeia de caracteres. O Visualizador de Eventos usa os identificadores de recurso para exibir as cadeias de caracteres correspondentes do arquivo de recurso localizado para o Source. Você deve registrar a origem com o arquivo de recurso correspondente antes de gravar eventos usando identificadores de recurso.

A instância de entrada instance especifica a mensagem de evento e as propriedades. Defina o InstanceId da instance entrada para a mensagem definida no arquivo de recurso de mensagem de origem. Opcionalmente, você pode definir o CategoryId e EntryType da instance entrada para definir a categoria e o tipo de evento de sua entrada de evento. Você também pode especificar uma matriz de cadeias de caracteres independentes de idioma para inserir no texto da mensagem localizada. Defina values como null se a mensagem de evento não contiver espaços reservados de formatação para cadeias de caracteres de substituição.

Especifique dados binários com um evento quando for necessário fornecer detalhes adicionais para o evento. Por exemplo, use o data parâmetro para incluir informações sobre um erro específico. O Visualizador de Eventos não interpreta os dados de evento associados; ele exibe os dados em um formato hexadecimal e de texto combinados. Usar dados específicos do evento com moderação; inclua-o somente se você tiver certeza de que será útil. Você também pode usar dados específicos do evento para armazenar informações que o aplicativo pode processar independentemente do Visualizador de Eventos. Por exemplo, você pode escrever um visualizador especificamente para seus eventos ou escrever um programa que examina o log de eventos e cria relatórios que incluem informações dos dados específicos do evento.

Você deve definir a Source propriedade em seu EventLog componente antes do componente antes de usar WriteEvent. A origem especificada deve ser configurada para gravar entradas localizadas no log; a origem deve, no mínimo, ter um arquivo de recurso de mensagem definido.

Você deve criar e configurar a origem do evento antes de gravar a primeira entrada com a origem. Create a nova origem do evento durante a instalação do aplicativo. Isso permite tempo para o sistema operacional atualizar sua lista de fontes de eventos registradas e sua configuração. Se o sistema operacional não tiver atualizado sua lista de fontes de eventos e você tentar gravar um evento com a nova origem, a operação de gravação falhará. Você pode configurar uma nova fonte usando um EventLogInstallerou usando o CreateEventSource método . Você deve ter direitos administrativos no computador para criar uma nova fonte de evento.

Observação

Se você não especificar um MachineName para sua EventLog instância antes de chamar WriteEvent, o computador local (".") será assumido.

A origem deve ser configurada para gravar entradas localizadas ou para gravar cadeias de caracteres diretas. Use o método se o WriteEntry aplicativo gravar valores de cadeia de caracteres diretamente no log de eventos.

Se o aplicativo gravar entradas usando identificadores de recurso e valores de cadeia de caracteres, você deverá registrar duas fontes separadas. Por exemplo, configure uma fonte com arquivos de recurso e use essa origem WriteEvent no método para gravar entradas usando identificadores de recurso no log de eventos. Em seguida, crie uma fonte diferente sem arquivos de recurso e use essa origem WriteEntry no método para gravar cadeias de caracteres diretamente no log de eventos usando essa origem.

Observação

Se você gravar uma entrada em um computador remoto, o valor da cadeia de message caracteres poderá não ser o esperado se o computador remoto não estiver executando o .NET Framework. Além disso, a message cadeia de caracteres não pode conter %n, em que n é um valor inteiro (por exemplo, %1), porque o visualizador de eventos a trata como uma cadeia de caracteres de inserção. Como um protocolo da Internet, o endereço IPv6 (versão 6) pode conter essa sequência de caracteres, você não pode registrar uma mensagem de evento que contenha um endereço IPv6.

Confira também

Aplica-se a

WriteEvent(String, EventInstance, Byte[], Object[])

Origem:
EventLog.cs
Origem:
EventLog.cs
Origem:
EventLog.cs

Grava uma entrada de log de eventos com os dados de evento, cadeias de caracteres de substituição de mensagem e os dados binários associados e usando a origem do evento registrada especificada.

public:
 static void WriteEvent(System::String ^ source, System::Diagnostics::EventInstance ^ instance, cli::array <System::Byte> ^ data, ... cli::array <System::Object ^> ^ values);
public static void WriteEvent (string source, System.Diagnostics.EventInstance instance, byte[] data, params object[] values);
static member WriteEvent : string * System.Diagnostics.EventInstance * byte[] * obj[] -> unit
Public Shared Sub WriteEvent (source As String, instance As EventInstance, data As Byte(), ParamArray values As Object())

Parâmetros

source
String

O nome da origem de evento registrada para o aplicativo no computador especificado.

instance
EventInstance

Uma instância EventInstance que representa uma entrada de log de eventos localizada.

data
Byte[]

Uma matriz de bytes que contém os dados binários associados à entrada.

values
Object[]

Uma matriz de cadeias de caracteres para mesclar o texto da mensagem da entrada de log de eventos.

Exceções

ArgumentException

O valor source é uma cadeia de caracteres vazia ("").

- ou -

O valor source é null.

- ou -

instance.InstanceId é menor que zero ou maior que UInt16.MaxValue.

- ou -

values tem mais de 256 elementos.

- ou -

Um dos elementos values é maior que 32766 bytes.

- ou -

O nome da origem resulta em um caminho de chave do Registro com mais de 254 caracteres.

ArgumentNullException

instance é null.

InvalidOperationException

Não foi possível abrir a chave do Registro para o log de eventos.

Win32Exception

O sistema operacional relatou um erro ao gravar a entrada de evento no log de eventos. Um código de erro do Windows não está disponível.

Exemplos

O exemplo a seguir grava uma entrada de evento informativo e uma entrada de evento de aviso em um log de eventos existente. O texto da mensagem de evento é especificado usando um identificador de recurso em um arquivo de recurso. O exemplo pressupõe que o arquivo de recurso correspondente foi registrado para a origem.

String^ sourceName = "SampleApplicationSource";
if ( EventLog::SourceExists( sourceName ) )
{
   
   // Define an informational event and a warning event.
   // The message identifiers correspond to the message text in the
   // message resource file defined for the source.
   EventInstance ^ myInfoEvent = gcnew EventInstance( InformationMsgId,0,EventLogEntryType::Information );
   EventInstance ^ myWarningEvent = gcnew EventInstance( WarningMsgId,0,EventLogEntryType::Warning );
   
   // Insert the method name into the event log message.
   array<String^>^insertStrings = {"EventLogSamples.WriteEventSample2"};
   
   // Write the events to the event log.
   EventLog::WriteEvent( sourceName, myInfoEvent, 0 );
   
   // Append binary data to the warning event entry.
   array<Byte>^binaryData = {7,8,9,10};
   EventLog::WriteEvent( sourceName, myWarningEvent, binaryData, insertStrings );
}
else
{
   Console::WriteLine( "Warning - event source {0} not registered", sourceName );
}


string sourceName = "SampleApplicationSource";
if(EventLog.SourceExists(sourceName))
{

    // Define an informational event and a warning event.

    // The message identifiers correspond to the message text in the
    // message resource file defined for the source.
    EventInstance myInfoEvent = new EventInstance(InformationMsgId, 0, EventLogEntryType.Information);
    EventInstance myWarningEvent = new EventInstance(WarningMsgId, 0, EventLogEntryType.Warning);

    // Insert the method name into the event log message.
    string [] insertStrings = {"EventLogSamples.WriteEventSample2"};

    // Write the events to the event log.

    EventLog.WriteEvent(sourceName, myInfoEvent);

    // Append binary data to the warning event entry.
    byte [] binaryData = { 7, 8, 9, 10 };
    EventLog.WriteEvent(sourceName, myWarningEvent, binaryData, insertStrings);
}
else
{
    Console.WriteLine("Warning - event source {0} not registered",
        sourceName);
}

           Dim sourceName As String = "SampleApplicationSource"
           If EventLog.SourceExists(sourceName)
  
               ' Define an informational event and a warning event.

               ' The message identifiers correspond to the message text in the
               ' message resource file defined for the source.
               Dim myInfoEvent As EventInstance = new EventInstance(InformationMsgId, 0, EventLogEntryType.Information)
               Dim myWarningEvent As EventInstance = new EventInstance(WarningMsgId, 0, EventLogEntryType.Warning)

               ' Insert the method name into the event log message.
               Dim insertStrings() As String = {"EventLogSamples.WriteEventSample2"}
           
               ' Write the events to the event log.

               EventLog.WriteEvent(sourceName, myInfoEvent, insertStrings)

               ' Append binary data to the warning event entry.
               Dim binaryData() As Byte = { 7, 8, 9, 10 }
               EventLog.WriteEvent(sourceName, myWarningEvent, binaryData, insertStrings)
           Else 
               Console.WriteLine("Warning - event source {0} not registered", _
                   sourceName)
           End If

O exemplo usa o seguinte arquivo de texto de mensagem, integrado à biblioteca de recursos EventLogMsgs.dll. Um arquivo de texto de mensagem é a origem da qual o arquivo de recurso de mensagem é criado. O arquivo de texto da mensagem define os identificadores de recurso e o texto para as cadeias de caracteres de categoria, mensagem de evento e inserção de parâmetros.

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

Use esse método para gravar uma entrada localizada com dados adicionais específicos do evento no log de eventos, usando uma fonte já registrada como uma fonte de evento para o log apropriado. Especifique as propriedades do evento com identificadores de recurso em vez de valores de cadeia de caracteres. O Visualizador de Eventos usa os identificadores de recurso para exibir as cadeias de caracteres correspondentes do arquivo de recurso localizado para a origem. Você deve registrar a origem com o arquivo de recurso correspondente antes de gravar eventos usando identificadores de recurso.

A instância de entrada instance especifica a mensagem de evento e as propriedades. Defina o InstanceId da instance entrada para a mensagem definida no arquivo de recurso de mensagem de origem. Opcionalmente, você pode definir o CategoryId e EntryType da instance entrada para definir a categoria e o tipo de evento de sua entrada de evento. Você também pode especificar uma matriz de cadeias de caracteres independentes de idioma para inserir no texto da mensagem localizada. Defina values como null se a mensagem de evento não contiver espaços reservados de formatação para cadeias de caracteres de substituição.

Especifique dados binários com um evento quando for necessário fornecer detalhes adicionais para o evento. Por exemplo, use o data parâmetro para incluir informações sobre um erro específico. O Visualizador de Eventos não interpreta os dados de evento associados; ele exibe os dados em um formato hexadecimal e de texto combinados. Usar dados específicos do evento com moderação; inclua-o somente se você tiver certeza de que será útil. Você também pode usar dados específicos do evento para armazenar informações que o aplicativo pode processar independentemente do Visualizador de Eventos. Por exemplo, você pode escrever um visualizador especificamente para seus eventos ou escrever um programa que examina o log de eventos e cria relatórios que incluem informações dos dados específicos do evento.

A origem especificada deve ser registrada para um log de eventos antes de usar WriteEvent. A origem especificada deve ser configurada para gravar entradas localizadas no log; a origem deve, no mínimo, ter um arquivo de recurso de mensagem definido.

Você deve criar e configurar a origem do evento antes de gravar a primeira entrada com a origem. Create a nova origem do evento durante a instalação do aplicativo. Isso permite tempo para o sistema operacional atualizar sua lista de fontes de eventos registradas e sua configuração. Se o sistema operacional não tiver atualizado sua lista de fontes de eventos e você tentar gravar um evento com a nova origem, a operação de gravação falhará. Você pode configurar uma nova fonte usando um EventLogInstallerou usando o CreateEventSource método . Você deve ter direitos administrativos no computador para criar uma nova fonte de evento.

A origem deve ser configurada para gravar entradas localizadas ou para gravar cadeias de caracteres diretas. Use o método se o WriteEntry aplicativo gravar valores de cadeia de caracteres diretamente no log de eventos.

Se o aplicativo gravar entradas usando identificadores de recurso e valores de cadeia de caracteres, você deverá registrar duas fontes separadas. Por exemplo, configure uma fonte com arquivos de recurso e use essa origem WriteEvent no método para gravar entradas usando identificadores de recurso no log de eventos. Em seguida, crie uma fonte diferente sem arquivos de recurso e use essa origem WriteEntry no método para gravar cadeias de caracteres diretamente no log de eventos usando essa origem.

Confira também

Aplica-se a