EventLog.WriteEvent Metoda

Definice

Obor názvů:

System.Diagnostics

Sestavení:

System.Diagnostics.EventLog.dll

Balíček:

System.Diagnostics.EventLog v8.0.0

Zapíše lokalizovanou položku události do protokolu událostí.

Přetížení

WriteEvent(String, EventInstance, Object[])	Zapíše položku protokolu událostí s danými daty událostí a řetězci pro nahrazení zprávy pomocí zadaného registrovaného zdroje událostí.
WriteEvent(EventInstance, Object[])	Zapíše lokalizovanou položku do protokolu událostí.
WriteEvent(EventInstance, Byte[], Object[])	Zapíše položku protokolu událostí s danými daty události, náhradními řetězci zpráv a přidruženými binárními daty.
WriteEvent(String, EventInstance, Byte[], Object[])	Zapíše položku protokolu událostí s danými daty události, náhradními řetězci zpráv a přidruženými binárními daty a pomocí zadaného registrovaného zdroje událostí.

WriteEvent(String, EventInstance, Object[])

Zdroj:

EventLog.cs

Zapíše položku protokolu událostí s danými daty událostí a řetězci pro nahrazení zprávy pomocí zadaného registrovaného zdroje událostí.

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())

Parametry

source

String

Název zdroje událostí zaregistrovaného pro aplikaci v zadaném počítači.

instance

EventInstance

Instance EventInstance , která představuje lokalizovanou položku protokolu událostí.

values

Object[]

Pole řetězců, které se mají sloučit do textu zprávy položky protokolu událostí.

Výjimky

ArgumentException

Hodnota source je prázdný řetězec ("").

-nebo-

Hodnota source je null.

-nebo-

instance.InstanceId je menší než nula nebo větší než UInt16.MaxValue.

-nebo-

values obsahuje více než 256 prvků.

-nebo-

Jeden z values prvků je delší než 32766 bajtů.

-nebo-

Výsledkem názvu zdroje je cesta ke klíči registru delší než 254 znaků.

ArgumentNullException

instance je null.

InvalidOperationException

Klíč registru pro protokol událostí nelze otevřít.

Win32Exception

Operační systém nahlásil chybu při zápisu položky události do protokolu událostí. Kód chyby systému Windows není k dispozici.

Příklady

Následující příklad zapíše položku informační události a položku události upozornění do existujícího protokolu událostí. Text zprávy události se zadává pomocí identifikátoru prostředku v souboru prostředku. Příklad předpokládá, že odpovídající soubor prostředků je zaregistrovaný pro zdroj.

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

Příklad používá následující textový soubor zprávy integrovaný do knihovny prostředků EventLogMsgs.dll. Textový soubor zprávy je zdroj, ze kterého je vytvořen soubor prostředků zprávy. Textový soubor zprávy definuje identifikátory prostředků a text pro řetězce vložení kategorie, zprávy události a parametru.

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

Poznámky

Tato metoda slouží k zápisu lokalizované položky do protokolu událostí pomocí zdroje, který je již zaregistrovaný jako zdroj událostí pro příslušný protokol. Vlastnosti události zadáte pomocí identifikátorů prostředků místo řetězcových hodnot. Prohlížeč událostí používá identifikátory prostředků k zobrazení odpovídajících řetězců z lokalizovaného souboru prostředků pro zdroj. Před zápisem událostí pomocí identifikátorů prostředků musíte zdroj zaregistrovat do odpovídajícího souboru prostředků.

Vstupní instance instance určuje zprávu a vlastnosti události. InstanceIdinstance Nastavte vstup pro definovanou zprávu v souboru zdroje zprávy. Volitelně můžete nastavit CategoryId a EntryTypeinstance vstupu, abyste definovali kategorii a typ události položky události. Můžete také zadat pole řetězců nezávislých na jazyce, které se vloží do lokalizovaného textu zprávy. Nastavte values na hodnotu null , pokud zpráva o události neobsahuje zástupné symboly formátování pro náhradní řetězce.

Před použitím WriteEventmusí být zadaný zdroj zaregistrovaný pro protokol událostí. Zadaný zdroj musí být nakonfigurován pro zápis lokalizovaných položek do protokolu; zdroj musí mít minimálně definovaný soubor prostředků zprávy.

Před zápisem první položky do zdroje musíte vytvořit a nakonfigurovat zdroj událostí. Create nový zdroj událostí během instalace aplikace. Operační systém tak může aktualizovat seznam registrovaných zdrojů událostí a jejich konfiguraci. Pokud operační systém neaktualizuje seznam zdrojů událostí a pokusíte se napsat událost s novým zdrojem, operace zápisu selže. Nový zdroj můžete nakonfigurovat pomocí EventLogInstallermetody nebo CreateEventSource . Abyste mohli vytvořit nový zdroj událostí, musíte mít v počítači oprávnění správce.

Zdroj musí být nakonfigurován pro zápis lokalizovaných položek nebo pro zápis přímých řetězců. Metodu použijte, WriteEntry pokud vaše aplikace zapisuje řetězcové hodnoty přímo do protokolu událostí.

Pokud vaše aplikace zapisuje položky pomocí identifikátorů prostředků i řetězcových hodnot, musíte zaregistrovat dva samostatné zdroje. Například nakonfigurujte jeden zdroj se soubory prostředků a pak ho WriteEvent použijte v metodě k zápisu položek pomocí identifikátorů prostředků do protokolu událostí. Pak vytvořte jiný zdroj bez souborů prostředků a použijte tento zdroj v WriteEntry metodě k zápisu řetězců přímo do protokolu událostí pomocí daného zdroje.

Viz také

• CreateEventSource
• Source
• Entries
• EventInstance

WriteEvent(EventInstance, Object[])

Zdroj:

EventLog.cs

Zapíše lokalizovanou položku do protokolu událostí.

public:
 void WriteEvent(System::Diagnostics::EventInstance ^ instance, ... cli::array <System::Object ^> ^ values);

public void WriteEvent (System.Diagnostics.EventInstance instance, params object[] values);

member this.WriteEvent : System.Diagnostics.EventInstance * obj[] -> unit

Public Sub WriteEvent (instance As EventInstance, ParamArray values As Object())

Parametry

instance

EventInstance

Instance EventInstance , která představuje lokalizovanou položku protokolu událostí.

values

Object[]

Pole řetězců, které se mají sloučit do textu zprávy položky protokolu událostí.

Výjimky

ArgumentException

Vlastnost Source objektu EventLog nebyla nastavena.

-nebo-

Metoda se pokusila zaregistrovat nový zdroj událostí, ale název počítače v MachineName souboru není platný.

-nebo-

Zdroj je již zaregistrovaný pro jiný protokol událostí.

-nebo-

instance.InstanceId je menší než nula nebo větší než UInt16.MaxValue.

-nebo-

values obsahuje více než 256 prvků.

-nebo-

Jeden z values prvků je delší než 32766 bajtů.

-nebo-

Výsledkem názvu zdroje je cesta ke klíči registru delší než 254 znaků.

ArgumentNullException

instance je null.

InvalidOperationException

Klíč registru pro protokol událostí nelze otevřít.

Win32Exception

Operační systém nahlásil chybu při zápisu položky události do protokolu událostí. Kód chyby systému Windows není k dispozici.

Příklady

Následující příklad zapíše dvě položky auditu do protokolu myNewLogudálostí . Příklad vytvoří nový zdroj událostí a nový protokol událostí, pokud neexistují v místním počítači. Text zprávy události se zadává pomocí identifikátoru prostředku v souboru prostředku.

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

Příklad používá následující textový soubor zprávy integrovaný do knihovny prostředků EventLogMsgs.dll. Textový soubor zprávy je zdroj, ze kterého je vytvořen soubor prostředků zprávy. Textový soubor zprávy definuje identifikátory prostředků a text pro řetězce vložení kategorie, zprávy události a parametru.

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

Poznámky

Tato metoda slouží k zápisu lokalizované položky do protokolu událostí. Vlastnosti události zadáte pomocí identifikátorů prostředků místo řetězcových hodnot. Prohlížeč událostí používá identifikátory prostředků k zobrazení odpovídajících řetězců z lokalizovaného souboru prostředků pro Source. Před zápisem událostí pomocí identifikátorů prostředků musíte zdroj zaregistrovat do odpovídajícího souboru prostředků.

Vstupní instance instance určuje zprávu a vlastnosti události. InstanceIdinstance Nastavte vstup pro definovanou zprávu v souboru zdroje zprávy. Volitelně můžete nastavit CategoryId a EntryTypeinstance vstupu, abyste definovali kategorii a typ události položky události. Můžete také zadat pole řetězců nezávislých na jazyce, které se vloží do lokalizovaného textu zprávy. Nastavte values na hodnotu null , pokud zpráva o události neobsahuje zástupné symboly formátování pro náhradní řetězce.

Před použitím WriteEventje nutné u komponenty EventLog nastavit Source vlastnost . Zadaný zdroj musí být nakonfigurován pro zápis lokalizovaných položek do protokolu; zdroj musí mít minimálně definovaný soubor prostředků zprávy.

Před zápisem první položky do zdroje musíte vytvořit a nakonfigurovat zdroj událostí. Create nový zdroj událostí během instalace aplikace. Operační systém tak může aktualizovat seznam registrovaných zdrojů událostí a jejich konfiguraci. Pokud operační systém neaktualizuje seznam zdrojů událostí a pokusíte se napsat událost s novým zdrojem, operace zápisu selže. Nový zdroj můžete nakonfigurovat pomocí EventLogInstallermetody nebo CreateEventSource . Abyste mohli vytvořit nový zdroj událostí, musíte mít v počítači oprávnění správce.

Zdroj musí být nakonfigurován pro zápis lokalizovaných položek nebo pro zápis přímých řetězců. Metodu použijte, WriteEntry pokud vaše aplikace zapisuje řetězcové hodnoty přímo do protokolu událostí.

Pokud vaše aplikace zapisuje položky pomocí identifikátorů prostředků i řetězcových hodnot, musíte zaregistrovat dva samostatné zdroje. Například nakonfigurujte jeden zdroj se soubory prostředků a pak ho WriteEvent použijte v metodě k zápisu položek pomocí identifikátorů prostředků do protokolu událostí. Pak vytvořte jiný zdroj bez souborů prostředků a použijte tento zdroj v WriteEntry metodě k zápisu řetězců přímo do protokolu událostí pomocí daného zdroje.

Poznámka

Pokud zapíšete položku do vzdáleného počítače, hodnota message řetězce nemusí být to, co očekáváte, pokud vzdálený počítač není spuštěn rozhraní .NET Framework. message Řetězec také nemůže obsahovat %n, kde n je celočíselná hodnota (například %1), protože prohlížeč událostí s ním zachází jako s vloženým řetězcem. Vzhledem k tomu, že ip adresa verze 6 (IPv6) může obsahovat tuto posloupnost znaků, nelze protokolovat zprávu události, která obsahuje adresu IPv6.

Viz také

• CreateEventSource
• Source
• Entries
• EventInstance

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

Zdroj:

EventLog.cs

Zapíše položku protokolu událostí s danými daty události, náhradními řetězci zpráv a přidruženými binárními daty.

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

member this.WriteEvent : System.Diagnostics.EventInstance * byte[] * obj[] -> unit

Public Sub WriteEvent (instance As EventInstance, data As Byte(), ParamArray values As Object())

Parametry

instance

EventInstance

Instance EventInstance , která představuje lokalizovanou položku protokolu událostí.

data

Byte[]

Pole bajtů, které obsahuje binární data přidružená k položce.

values

Object[]

Pole řetězců, které se mají sloučit do textu zprávy položky protokolu událostí.

Výjimky

ArgumentException

Vlastnost Source objektu EventLog nebyla nastavena.

-nebo-

Metoda se pokusila zaregistrovat nový zdroj událostí, ale název počítače v MachineName souboru není platný.

-nebo-

Zdroj je již zaregistrovaný pro jiný protokol událostí.

-nebo-

instance.InstanceId je menší než nula nebo větší než UInt16.MaxValue.

-nebo-

values obsahuje více než 256 prvků.

-nebo-

Jeden z values prvků je delší než 32766 bajtů.

-nebo-

Výsledkem názvu zdroje je cesta ke klíči registru delší než 254 znaků.

ArgumentNullException

instance je null.

InvalidOperationException

Klíč registru pro protokol událostí nelze otevřít.

Win32Exception

Operační systém nahlásil chybu při zápisu položky události do protokolu událostí. Kód chyby systému Windows není k dispozici.

Příklady

Následující příklad zapíše dvě položky auditu do protokolu myNewLogudálostí . Příklad vytvoří nový zdroj událostí a nový protokol událostí, pokud neexistují v místním počítači. Text zprávy události se zadává pomocí identifikátoru prostředku v souboru prostředku.

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

Příklad používá následující textový soubor zprávy integrovaný do knihovny prostředků EventLogMsgs.dll. Textový soubor zprávy je zdroj, ze kterého je vytvořen soubor prostředků zprávy. Textový soubor zprávy definuje identifikátory prostředků a text pro řetězce vložení kategorie, zprávy události a parametru.

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

Poznámky

Tuto metodu použijte k zápisu lokalizované položky s dalšími daty specifickými pro události do protokolu událostí. Vlastnosti události zadáte pomocí identifikátorů prostředků místo řetězcových hodnot. Prohlížeč událostí používá identifikátory prostředků k zobrazení odpovídajících řetězců z lokalizovaného souboru prostředků pro Source. Před zápisem událostí pomocí identifikátorů prostředků musíte zdroj zaregistrovat do odpovídajícího souboru prostředků.

Vstupní instance instance určuje zprávu a vlastnosti události. InstanceIdinstance Nastavte vstup pro definovanou zprávu v souboru zdroje zprávy. Volitelně můžete nastavit CategoryId a EntryTypeinstance vstupu, abyste definovali kategorii a typ události položky události. Můžete také zadat pole řetězců nezávislých na jazyce, které se vloží do lokalizovaného textu zprávy. Nastavte values na hodnotu null , pokud zpráva o události neobsahuje zástupné symboly formátování pro náhradní řetězce.

Pokud je potřeba zadat další podrobnosti o události, zadejte binární data s událostí. Použijte například data parametr k zahrnutí informací o konkrétní chybě. Prohlížeč událostí neinterpretuje přidružená data událostí; zobrazuje data v kombinovaném šestnáctkovém a textovém formátu. Používejte data specifická pro konkrétní události střídmě; zahrňte ho pouze v případě, že jste si jistí, že to bude užitečné. Data specifická pro událost můžete také použít k ukládání informací, které aplikace může zpracovávat nezávisle na Prohlížeč událostí. Můžete například napsat prohlížeč speciálně pro vaše události nebo napsat program, který prohledá protokol událostí a vytvoří sestavy, které obsahují informace z dat specifických pro danou událost.

Před použitím komponenty je nutné nastavit Source vlastnost komponenty EventLog před použitím WriteEventkomponenty . Zadaný zdroj musí být nakonfigurován pro zápis lokalizovaných položek do protokolu; zdroj musí mít minimálně definovaný soubor prostředků zprávy.

Před zápisem první položky do zdroje musíte vytvořit a nakonfigurovat zdroj událostí. Create nový zdroj událostí během instalace aplikace. Operační systém tak může aktualizovat seznam registrovaných zdrojů událostí a jejich konfiguraci. Pokud operační systém neaktualizuje seznam zdrojů událostí a pokusíte se napsat událost s novým zdrojem, operace zápisu selže. Nový zdroj můžete nakonfigurovat pomocí EventLogInstallermetody nebo CreateEventSource . Abyste mohli vytvořit nový zdroj událostí, musíte mít v počítači oprávnění správce.

Poznámka

Pokud nezadáte pro svoji EventLog instanci před voláním MachineNameWriteEvent, předpokládá se místní počítač (".").

Zdroj musí být nakonfigurován pro zápis lokalizovaných položek nebo pro zápis přímých řetězců. Metodu použijte, WriteEntry pokud vaše aplikace zapisuje řetězcové hodnoty přímo do protokolu událostí.

Pokud vaše aplikace zapisuje položky pomocí identifikátorů prostředků i řetězcových hodnot, musíte zaregistrovat dva samostatné zdroje. Například nakonfigurujte jeden zdroj se soubory prostředků a pak ho WriteEvent použijte v metodě k zápisu položek pomocí identifikátorů prostředků do protokolu událostí. Pak vytvořte jiný zdroj bez souborů prostředků a použijte tento zdroj v WriteEntry metodě k zápisu řetězců přímo do protokolu událostí pomocí daného zdroje.

Poznámka

Pokud zapíšete položku do vzdáleného počítače, hodnota message řetězce nemusí být to, co očekáváte, pokud vzdálený počítač není spuštěn rozhraní .NET Framework. message Řetězec také nemůže obsahovat %n, kde n je celočíselná hodnota (například %1), protože prohlížeč událostí s ním zachází jako s vloženým řetězcem. Vzhledem k tomu, že ip adresa verze 6 (IPv6) může obsahovat tuto posloupnost znaků, nelze protokolovat zprávu události, která obsahuje adresu IPv6.

Viz také

• CreateEventSource
• Source
• Entries
• EventInstance

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

Zdroj:

EventLog.cs

Zapíše položku protokolu událostí s danými daty události, náhradními řetězci zpráv a přidruženými binárními daty a pomocí zadaného registrovaného zdroje událostí.

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())

Parametry

source

String

Název zdroje událostí zaregistrovaného pro aplikaci v zadaném počítači.

instance

EventInstance

Instance EventInstance , která představuje lokalizovanou položku protokolu událostí.

data

Byte[]

Pole bajtů, které obsahuje binární data přidružená k položce.

values

Object[]

Pole řetězců, které se mají sloučit do textu zprávy položky protokolu událostí.

Výjimky

ArgumentException

Hodnota source je prázdný řetězec ("").

-nebo-

Hodnota source je null.

-nebo-

instance.InstanceId je menší než nula nebo větší než UInt16.MaxValue.

-nebo-

values obsahuje více než 256 prvků.

-nebo-

Jeden z values prvků je delší než 32766 bajtů.

-nebo-

Výsledkem názvu zdroje je cesta ke klíči registru delší než 254 znaků.

ArgumentNullException

instance je null.

InvalidOperationException

Klíč registru pro protokol událostí nelze otevřít.

Win32Exception

Operační systém nahlásil chybu při zápisu položky události do protokolu událostí. Kód chyby systému Windows není k dispozici.

Příklady

Následující příklad zapíše položku informační události a položku události upozornění do existujícího protokolu událostí. Text zprávy události se zadává pomocí identifikátoru prostředku v souboru prostředku. Příklad předpokládá, že odpovídající soubor prostředků je zaregistrovaný pro zdroj.

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

Příklad používá následující textový soubor zprávy integrovaný do knihovny prostředků EventLogMsgs.dll. Textový soubor zprávy je zdroj, ze kterého je vytvořen soubor prostředků zprávy. Textový soubor zprávy definuje identifikátory prostředků a text pro řetězce vložení kategorie, zprávy události a parametru.

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

Poznámky

Tuto metodu použijte k zápisu lokalizované položky s dalšími daty specifickými pro událost do protokolu událostí pomocí zdroje, který je již zaregistrovaný jako zdroj událostí pro příslušný protokol. Vlastnosti události zadáte pomocí identifikátorů prostředků místo řetězcových hodnot. Prohlížeč událostí používá identifikátory prostředků k zobrazení odpovídajících řetězců z lokalizovaného souboru prostředků pro zdroj. Před zápisem událostí pomocí identifikátorů prostředků musíte zdroj zaregistrovat pomocí odpovídajícího souboru prostředků.

Vstupní instance instance určuje zprávu a vlastnosti události. InstanceIdinstance Nastavte vstup pro definovanou zprávu v souboru prostředků zdrojové zprávy. Volitelně můžete nastavit CategoryId a EntryTypeinstance vstupu, abyste definovali kategorii a typ události položky události. Můžete také zadat pole řetězců nezávislých na jazyce, které se mají vložit do lokalizovaného textu zprávy. Nastavte values na , null pokud zpráva události neobsahuje formátovací zástupné symboly pro náhradní řetězce.

Zadejte binární data s událostí, pokud je nutné zadat další podrobnosti o události. Parametr použijte data například k zahrnutí informací o konkrétní chybě. Prohlížeč událostí neinterpretuje přidružená data událostí; zobrazuje je v kombinovaném šestnáctkovém a textovém formátu. Používejte data specifická pro události střídmě; zahrnout pouze v případě, že jste si jisti, že to bude užitečné. Data specifická pro události můžete také použít k ukládání informací, které aplikace může zpracovat nezávisle na Prohlížeč událostí. Můžete například napsat prohlížeč speciálně pro vaše události nebo napsat program, který prohledá protokol událostí a vytvoří sestavy obsahující informace z dat specifických pro danou událost.

Před použitím WriteEventmusí být zadaný zdroj zaregistrovaný pro protokol událostí. Zadaný zdroj musí být nakonfigurován pro zápis lokalizovaných položek do protokolu; zdroj musí mít definovaný minimálně soubor prostředků zprávy.

Před zápisem první položky do zdroje musíte vytvořit a nakonfigurovat zdroj událostí. Create nový zdroj událostí během instalace aplikace. Operační systém tak může aktualizovat seznam registrovaných zdrojů událostí a jejich konfiguraci. Pokud operační systém neaktualizuje seznam zdrojů událostí a pokusíte se napsat událost s novým zdrojem, operace zápisu selže. Nový zdroj můžete nakonfigurovat pomocí EventLogInstaller, nebo pomocí CreateEventSource metody . K vytvoření nového zdroje událostí musíte mít v počítači oprávnění správce.

Zdroj musí být nakonfigurován pro zápis lokalizovaných položek nebo pro zápis přímých řetězců. WriteEntry Pokud vaše aplikace zapisuje řetězcové hodnoty přímo do protokolu událostí, použijte metodu .

Pokud aplikace zapisuje položky pomocí identifikátorů prostředků i řetězcových hodnot, musíte zaregistrovat dva samostatné zdroje. Například nakonfigurujte jeden zdroj se soubory prostředků a pak tento zdroj použijte v WriteEvent metodě k zápisu položek do protokolu událostí pomocí identifikátorů prostředků. Pak vytvořte jiný zdroj bez souborů prostředků a použijte tento zdroj v WriteEntry metodě k zápisu řetězců přímo do protokolu událostí pomocí daného zdroje.

Viz také

• CreateEventSource
• Source
• Entries
• EventInstance