EventLog.RegisterDisplayName(String, Int64) Метод

Определение

Пространство имен:: System.Diagnostics

Сборка:: System.Diagnostics.EventLog.dll

Сборка:: System.dll

Пакет:: System.Diagnostics.EventLog v11.0.0-preview.7.26381.103

Исходный код:: EventLog.cs

Исходный код:: EventLog.cs

Исходный код:: EventLog.cs

Исходный код:: EventLog.cs

Исходный код:: EventLog.cs

Исходный код:: EventLog.cs

Исходный код:: EventLog.cs

Исходный код:: EventLog.cs

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Указывает локализованное имя журнала событий, которое отображается в средстве просмотра событий сервера.

public:
 void RegisterDisplayName(System::String ^ resourceFile, long resourceId);

public void RegisterDisplayName(string resourceFile, long resourceId);

[System.Runtime.InteropServices.ComVisible(false)]
public void RegisterDisplayName(string resourceFile, long resourceId);

member this.RegisterDisplayName : string * int64 -> unit

[<System.Runtime.InteropServices.ComVisible(false)>]
member this.RegisterDisplayName : string * int64 -> unit

Public Sub RegisterDisplayName (resourceFile As String, resourceId As Long)

Параметры

resourceFile: String

Полный указанный путь к локализованным файлу ресурсов.

resourceId: Int64

Идентификатор ресурса, индексируемый локализованной строкой в файле ресурса.

Атрибуты: ComVisibleAttribute

Исключения

InvalidOperationException

Значение Log не является допустимым именем журнала.

–или–

Не удалось открыть раздел реестра для журнала событий на целевом компьютере.

ArgumentNullException

resourceFile равно null.

Примеры

В следующем примере определяется, зарегистрирован ли источник SampleApplicationSource событий на локальном компьютере. Если источник событий не существует, в примере задается файл ресурса сообщения для источника и создается новый источник события. Наконец, в примере задается локализованное отображаемое имя для журнала событий, используя значение DisplayNameMsgId идентификатора ресурса и путь к файлу ресурса.messageFile

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

В примере используется следующий текстовый файл сообщения, встроенный в библиотеку ресурсов EventLogMsgs.dll. Текстовый файл сообщения — это источник, из которого создается файл ресурса сообщения. Текстовый файл сообщения определяет идентификаторы ресурсов и текст для категорий, сообщений о событии и строк вставки параметров. В частности, идентификатор ресурса 5001 определяется для локализованного имени журнала событий.

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

Указанный идентификатор ресурса должен соответствовать локализованной строке, определенной в файле ресурса. В Просмотр событий отображается пользовательское имя журнала событий с помощью локализованной строки и текущих параметров языка и региональных параметров. Например, можно определить несколько имен журналов событий, локализованных для разных региональных параметров в файле ресурса. В Просмотр событий отображается локализованная строка, соответствующая параметрам языка и региональных параметров текущего пользователя.

Если Просмотр событий не удается загрузить локализованную строку из файла ресурса или если отображаемое имя не зарегистрировано для журнала событий, Просмотр событий отображает имя журнала событий, определенное в Log.

Note

Не нужно регистрировать отображаемое имя для предварительно определенных журналов событий. Операционная система регистрирует локализованные отображаемые имена для журналов событий Application, System и Security.

Применяется к

См. также раздел

LogDisplayName

Обратная связь

Были ли сведения на этой странице полезными?