EventSourceCreationData.MessageResourceFile Propriedade
Definição
Obtém ou define o caminho do arquivo de recurso da mensagem que contém a cadeia de caracteres de formatação de mensagem para a origem.Gets or sets the path of the message resource file that contains message formatting strings for the source.
public:
property System::String ^ MessageResourceFile { System::String ^ get(); void set(System::String ^ value); };
public string MessageResourceFile { get; set; }
member this.MessageResourceFile : string with get, set
Public Property MessageResourceFile As String
Valor da propriedade
O caminho do arquivo de recurso da mensagem.The path of the message resource file. O padrão é uma cadeia de caracteres vazia ("").The default is an empty string ("").
Exemplos
O exemplo de código a seguir determina se a origem do evento chamada SampleApplicationSource está registrada no computador local.The following code example determines whether the event source named SampleApplicationSource is registered on the local computer. Se a origem do evento não existir, o exemplo definirá o arquivo de recurso de mensagem para a origem e criará a nova origem do evento.If the event source does not exist, the example sets the message resource file for the source and creates the new event source. Por fim, o exemplo de código define o nome de exibição localizado para o log de eventos, usando o valor do identificador de recurso em DisplayNameMsgId e o caminho do arquivo de recurso em messageFile .Finally, the code example sets the localized display name for the event log, using the resource identifier value in DisplayNameMsgId and the resource file path in messageFile.
void CreateEventSourceSample1( String^ messageFile )
{
String^ myLogName;
String^ sourceName = "SampleApplicationSource";
// Create the event source if it does not exist.
if ( !EventLog::SourceExists( sourceName ) )
{
// Create a new event source for the custom event log
// named "myNewLog."
myLogName = "myNewLog";
EventSourceCreationData ^ mySourceData = gcnew EventSourceCreationData( sourceName,myLogName );
// Set the message resource file that the event source references.
// All event resource identifiers correspond to text in this file.
if ( !System::IO::File::Exists( messageFile ) )
{
Console::WriteLine( "Input message resource file does not exist - {0}", messageFile );
messageFile = "";
}
else
{
// Set the specified file as the resource
// file for message text, category text, and
// message parameter strings.
mySourceData->MessageResourceFile = messageFile;
mySourceData->CategoryResourceFile = messageFile;
mySourceData->CategoryCount = CategoryCount;
mySourceData->ParameterResourceFile = messageFile;
Console::WriteLine( "Event source message resource file set to {0}", messageFile );
}
Console::WriteLine( "Registering new source for event log." );
EventLog::CreateEventSource( mySourceData );
}
else
{
// Get the event log corresponding to the existing source.
myLogName = EventLog::LogNameFromSourceName( sourceName, "." );
}
// Register the localized name of the event log.
// For example, the actual name of the event log is "myNewLog," but
// the event log name displayed in the Event Viewer might be
// "Sample Application Log" or some other application-specific
// text.
EventLog^ myEventLog = gcnew EventLog( myLogName,".",sourceName );
if ( messageFile->Length > 0 )
{
myEventLog->RegisterDisplayName( messageFile, DisplayNameMsgId );
}
}
static void CreateEventSourceSample1(string messageFile)
{
string myLogName;
string sourceName = "SampleApplicationSource";
// Create the event source if it does not exist.
if(!EventLog.SourceExists(sourceName))
{
// Create a new event source for the custom event log
// named "myNewLog."
myLogName = "myNewLog";
EventSourceCreationData mySourceData = new EventSourceCreationData(sourceName, myLogName);
// Set the message resource file that the event source references.
// All event resource identifiers correspond to text in this file.
if (!System.IO.File.Exists(messageFile))
{
Console.WriteLine("Input message resource file does not exist - {0}",
messageFile);
messageFile = "";
}
else
{
// Set the specified file as the resource
// file for message text, category text, and
// message parameter strings.
mySourceData.MessageResourceFile = messageFile;
mySourceData.CategoryResourceFile = messageFile;
mySourceData.CategoryCount = CategoryCount;
mySourceData.ParameterResourceFile = messageFile;
Console.WriteLine("Event source message resource file set to {0}",
messageFile);
}
Console.WriteLine("Registering new source for event log.");
EventLog.CreateEventSource(mySourceData);
}
else
{
// Get the event log corresponding to the existing source.
myLogName = EventLog.LogNameFromSourceName(sourceName,".");
}
// Register the localized name of the event log.
// For example, the actual name of the event log is "myNewLog," but
// the event log name displayed in the Event Viewer might be
// "Sample Application Log" or some other application-specific
// text.
EventLog myEventLog = new EventLog(myLogName, ".", sourceName);
if (messageFile.Length > 0)
{
myEventLog.RegisterDisplayName(messageFile, DisplayNameMsgId);
}
}
Public Shared Sub CreateEventSourceSample1(ByVal messageFile As String)
Dim myLogName As String
Dim sourceName As String = "SampleApplicationSource"
' Create the event source if it does not exist.
If Not EventLog.SourceExists(sourceName)
' Create a new event source for the custom event log
' named "myNewLog."
myLogName = "myNewLog"
Dim mySourceData As EventSourceCreationData = New EventSourceCreationData(sourceName, myLogName)
' Set the message resource file that the event source references.
' All event resource identifiers correspond to text in this file.
If Not System.IO.File.Exists(messageFile)
Console.WriteLine("Input message resource file does not exist - {0}", _
messageFile)
messageFile = ""
Else
' Set the specified file as the resource
' file for message text, category text and
' message parameters strings.
mySourceData.MessageResourceFile = messageFile
mySourceData.CategoryResourceFile = messageFile
mySourceData.CategoryCount = CategoryCount
mySourceData.ParameterResourceFile = messageFile
Console.WriteLine("Event source message resource file set to {0}", _
messageFile)
End If
Console.WriteLine("Registering new source for event log.")
EventLog.CreateEventSource(mySourceData)
Else
' Get the event log corresponding to the existing source.
myLogName = EventLog.LogNameFromSourceName(sourceName,".")
End If
' Register the localized name of the event log.
' For example, the actual name of the event log is "myNewLog," but
' the event log name displayed in the Event Viewer might be
' "Sample Application Log" or some other application-specific
' text.
Dim myEventLog As EventLog = New EventLog(myLogName, ".", sourceName)
If messageFile.Length > 0
myEventLog.RegisterDisplayName(messageFile, DisplayNameMsgId)
End If
End Sub
O exemplo de código usa o seguinte arquivo de texto de mensagem, interno à biblioteca de recursos EventLogMsgs.dll.The code example uses the following message text file, built into the resource library EventLogMsgs.dll. Um arquivo de texto de mensagem é a origem da qual o arquivo de recurso de mensagem é criado.A message text file is the source from which the message resource file is created. O arquivo de texto da mensagem define os identificadores de recurso e o texto para a categoria, a mensagem de evento e as cadeias de caracteres de inserção de parâmetro.The message text file defines the resource identifiers and text for the category, event message, and parameter insertion strings.
; // EventLogMsgs.mc
; // ********************************************************
; // Use the following commands to build this file:
; // mc -s EventLogMsgs.mc
; // rc EventLogMsgs.rc
; // link /DLL /SUBSYSTEM:WINDOWS /NOENTRY /MACHINE:x86 EventLogMsgs.Res
; // ********************************************************
; // - Event categories -
; // Categories must be numbered consecutively starting at 1.
; // ********************************************************
MessageId=0x1
Severity=Success
SymbolicName=INSTALL_CATEGORY
Language=English
Installation
.
MessageId=0x2
Severity=Success
SymbolicName=QUERY_CATEGORY
Language=English
Database Query
.
MessageId=0x3
Severity=Success
SymbolicName=REFRESH_CATEGORY
Language=English
Data Refresh
.
; // - Event messages -
; // *********************************
MessageId = 1000
Severity = Success
Facility = Application
SymbolicName = AUDIT_SUCCESS_MESSAGE_ID_1000
Language=English
My application message text, in English, for message id 1000, called from %1.
.
MessageId = 1001
Severity = Warning
Facility = Application
SymbolicName = AUDIT_FAILED_MESSAGE_ID_1001
Language=English
My application message text, in English, for message id 1001, called from %1.
.
MessageId = 1002
Severity = Success
Facility = Application
SymbolicName = GENERIC_INFO_MESSAGE_ID_1002
Language=English
My generic information message in English, for message id 1002.
.
MessageId = 1003
Severity = Warning
Facility = Application
SymbolicName = GENERIC_WARNING_MESSAGE_ID_1003
Language=English
My generic warning message in English, for message id 1003, called from %1.
.
MessageId = 1004
Severity = Success
Facility = Application
SymbolicName = UPDATE_CYCLE_COMPLETE_MESSAGE_ID_1004
Language=English
The update cycle is complete for %%5002.
.
MessageId = 1005
Severity = Warning
Facility = Application
SymbolicName = SERVER_CONNECTION_DOWN_MESSAGE_ID_1005
Language=English
The refresh operation did not complete because the connection to server %1 could not be established.
.
; // - Event log display name -
; // ********************************************************
MessageId = 5001
Severity = Success
Facility = Application
SymbolicName = EVENT_LOG_DISPLAY_NAME_MSGID
Language=English
Sample Event Log
.
; // - Event message parameters -
; // Language independent insertion strings
; // ********************************************************
MessageId = 5002
Severity = Success
Facility = Application
SymbolicName = EVENT_LOG_SERVICE_NAME_MSGID
Language=English
SVC_UPDATE.EXE
.
Comentários
Use a MessageResourceFile propriedade para configurar uma origem do log de eventos para gravar mensagens de evento localizadas.Use the MessageResourceFile property to configure an event log source to write localized event messages. Mensagens de evento são cadeias de caracteres definidas pelo aplicativo que descrevem o evento para o usuário.Event messages are application-defined strings that describe the event to the user.
Seu aplicativo pode gravar entradas de log de eventos usando identificadores de recursos.Your application can write event log entries using resource identifiers. Um identificador de recurso indexa uma mensagem localizada no MessageResourceFile .A resource identifier indexes a message located in the MessageResourceFile. O Visualizador de Eventos usa o identificador de recurso para localizar e exibir a cadeia de caracteres correspondente do arquivo de recurso de mensagem localizado com base nas configurações de idioma atuais.The Event Viewer uses the resource identifier to find and display the corresponding string from the localized message resource file based on current language settings.
A origem do evento deve ser configurada para gravar entradas localizadas ou para gravar cadeias de caracteres diretas.The event source must be configured either for writing localized entries or for writing direct strings. Use o WriteEvent método para gravar entradas localizadas para uma fonte configurada com um arquivo de recurso de mensagem.Use the WriteEvent method to write localized entries for a source configured with a message resource file.
Se seu aplicativo grava cadeias de caracteres de mensagem de evento diretamente, em vez de usar um identificador de recurso em um arquivo de recurso localizado, não defina a MessageResourceFile propriedade.If your application writes event message strings directly, rather than using a resource identifier in a localized resource file, do not set the MessageResourceFile property.
Para obter detalhes sobre como definir mensagens de evento e criar arquivos de recurso de evento, consulte o artigo do compilador de mensagens na documentação do Platform SDK.For details about defining event messages and building event resource files, see the Message Compiler article in the Platform SDK documentation.