EventLogInstaller.MessageResourceFile プロパティとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

EventLogInstaller.MessageResourceFile プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

ソースのメッセージ書式指定文字列が格納されたリソースファイルのパスを取得または設定します。

名前空間: System.Diagnostics
アセンブリ: System.Configuration.Install (system.configuration.install.dll 内)
構文

Visual Basic (宣言)

<ComVisibleAttribute(False)> _
Public Property MessageResourceFile As
 String

Visual Basic (使用法)

Dim instance As EventLogInstaller
Dim value As String

value = instance.MessageResourceFile

instance.MessageResourceFile = value

[ComVisibleAttribute(false)] 
public string MessageResourceFile { get;
 set; }

C++

[ComVisibleAttribute(false)] 
public:
property String^ MessageResourceFile {
    String^ get ();
    void set (String^ value);
}

/** @property */
public String get_MessageResourceFile ()

/** @property */
public void set_MessageResourceFile (String
 value)

JScript

public function get MessageResourceFile
 () : String

public function set MessageResourceFile
 (value : String)

プロパティ値
メッセージリソースファイルのパス。既定値は空の文字列 ("") です。

解説

ローカライズされたイベントメッセージを書き込むようにイベントログソースを構成するには、MessageResourceFile プロパティを使用します。イベントメッセージは、イベントをユーザーに説明するアプリケーション定義の文字列です。

アプリケーションは、リソース識別子を使用してイベントログエントリを書き込むことができます。リソース識別子は、MessageResourceFile にあるメッセージのインデックスを作成します。イベントビューアでは、リソース識別子を使用して、ローカライズされたリソースファイルから、現在の言語設定に基づく対応する文字列を検索して表示させることができます。

イベントソースは、ローカライズされたエントリを書き込むか、または直接の文字列を書き込むように構成されている必要があります。メッセージリソースファイルで構成されたソースのローカライズされたエントリを書き込むには、WriteEvent メソッドを使用します。

アプリケーションが、ローカライズされたリソースファイルのリソース識別子を使用するのではなく、イベントメッセージ文字列を直接書き込む場合は、MessageResourceFile プロパティを設定しないでください。

イベントメッセージの定義およびイベントリソースファイルの作成の詳細については、http://www.microsoft.com/japan/msdn のプラットフォーム SDK ドキュメントで「Message Compiler」のトピックを参照してください。

使用例

新しいイベントソースのインストールプロパティを設定するコード例を次に示します。このコード例は、ローカライズされたイベントテキストのイベントソース名、イベントログ名、およびリソースファイルを設定します。

Visual Basic

Imports System
Imports System.Configuration.Install
Imports System.Diagnostics
Imports System.ComponentModel

<RunInstaller(True)>  _
Public Class SampleEventLogInstaller
   Inherits Installer

   Private myEventLogInstaller As EventLogInstaller
   
   Public Sub New()

      ' Create an instance of an EventLogInstaller.
      myEventLogInstaller = New EventLogInstaller()

      ' Set the source name of the event log.
      myEventLogInstaller.Source = "ApplicationEventSource"

      ' Set the event log into which the source writes entries.
      myEventLogInstaller.Log = "MyCustomLog"

      ' Set the resource file for the event log.
      ' The message strings are defined in EventLogMsgs.mc; the message
 
      ' identifiers used in the application must match those defined
 in the
      ' corresponding message resource file. The messages must be built
      ' into a Win32 resource library and copied to the target path
 on the
      ' system.  
 
      myEventLogInstaller.CategoryResourceFile = "%SystemRoot%\System32\eventlogmsgs.dll"
      myEventLogInstaller.CategoryCount = 3
      myEventLogInstaller.MessageResourceFile = "%SystemRoot%\System32\eventlogmsgs.dll"
      myEventLogInstaller.ParameterResourceFile = "%SystemRoot%\System32\eventlogmsgs.dll"

      ' Add myEventLogInstaller to the installer collection.
      Installers.Add(myEventLogInstaller)

   End Sub 'New

   Public Shared Sub Main()
     Console.WriteLine("Usage: InstallUtil.exe [<install>.exe
 | <install>.dll]")
   End Sub 'Main
End Class 'MyEventLogInstaller

using System;
using System.Configuration.Install;
using System.Diagnostics;
using System.ComponentModel;

[RunInstaller(true)]
public class SampleEventLogInstaller: Installer
{
    private EventLogInstaller myEventLogInstaller;

    public SampleEventLogInstaller() 
    {
        // Create an instance of an EventLogInstaller.
        myEventLogInstaller = new EventLogInstaller();

        // Set the source name of the event log.
        myEventLogInstaller.Source = "ApplicationEventSource";

        // Set the event log into which the source writes entries.
        //myEventLogInstaller.Log = "MyCustomLog";
        myEventLogInstaller.Log = "myNewLog";

        // Set the resource file for the event log.
        // The message strings are defined in EventLogMsgs.mc; the message
 
        // identifiers used in the application must match those defined
 in the
        // corresponding message resource file. The messages must be
 built
        // into a Win32 resource library and copied to the target path
 on the
        // system.  
            
        myEventLogInstaller.CategoryResourceFile = @"%SystemRoot%\System32\eventlogmsgs.dll";
        myEventLogInstaller.CategoryCount = 3;
        myEventLogInstaller.MessageResourceFile = @"%SystemRoot%\System32\eventlogmsgs.dll";
        myEventLogInstaller.ParameterResourceFile = @"%SystemRoot%\System32\eventlogmsgs.dll";

        // Add myEventLogInstaller to the installer collection.
        Installers.Add(myEventLogInstaller); 
    }

    public static void Main()
    {
        Console.WriteLine("Usage: InstallUtil.exe [<install>.exe | <install>.dll]");
    }
}

C++

#using <System.dll>
#using <System.Configuration.Install.dll>

using namespace System;
using namespace System::Configuration::Install;
using namespace System::Diagnostics;
using namespace System::ComponentModel;

[RunInstaller(true)]
public ref class SampleEventLogInstaller: public
 Installer
{
private:
   EventLogInstaller^ myEventLogInstaller;

public:
   SampleEventLogInstaller()
   {
      
      // Create an instance of an EventLogInstaller.
      myEventLogInstaller = gcnew EventLogInstaller;
      
      // Set the source name of the event log.
      myEventLogInstaller->Source = "ApplicationEventSource";
      
      // Set the event log into which the source writes entries.
      //myEventLogInstaller.Log = "MyCustomLog";
      myEventLogInstaller->Log = "myNewLog";
      
      // Set the resource file for the event log.
      // The message strings are defined in EventLogMsgs.mc; the message
 
      // identifiers used in the application must match those defined
 in the
      // corresponding message resource file. The messages must be built
      // into a Win32 resource library and copied to the target path
 on the
      // system.  
      myEventLogInstaller->CategoryResourceFile = "%SystemRoot%\\System32\\eventlogmsgs.dll";
      myEventLogInstaller->CategoryCount = 3;
      myEventLogInstaller->MessageResourceFile = "%SystemRoot%\\System32\\eventlogmsgs.dll";
      myEventLogInstaller->ParameterResourceFile = "%SystemRoot%\\System32\\eventlogmsgs.dll";
      
      // Add myEventLogInstaller to the installer collection.
      Installers->Add( myEventLogInstaller );
   }

};

int main()
{
   Console::WriteLine( "Usage: InstallUtil.exe [<install>.exe | <install>.dll]"
 );
}

コード例では、リソースライブラリ EventLogMsgs.dll に組み込まれた、次のメッセージテキストファイルが使用されています。メッセージリソースファイルは、メッセージテキストファイルから生成されます。メッセージテキストファイルでは、リソース識別子の他、カテゴリ、イベントメッセージ、およびパラメータ挿入文字列のテキストが定義されます。

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