A Sandcastle Documented Class Library
GetMessage Method (messageId, args)
NamespacesTERASOLUNA.Fw.CommonMessageManagerGetMessage(String, array<Object>[]()[])
指定したメッセージ ID を利用してリソースから文字列を取得します。
Declaration Syntax
C#Visual BasicVisual C++
public static string GetMessage(
	string messageId,
	params Object[] args
)
Public Shared Function GetMessage ( _
	messageId As String, _
	ParamArray args As Object() _
) As String
public:
static String^ GetMessage(
	String^ messageId, 
	... array<Object^>^ args
)
Parameters
messageId (String)
リソースからメッセージを取得する際に利用する ID 。
args (array< Object >[]()[])
プレースホルダに適用する可変長引数。
Return Value
リソースから取得されたメッセージ文字列。
Remarks

内部で保持したリソース型のコレクションから、指定したキーに合致するメッセージ 文字列を取得します。利用するカルチャは ResourceCulture で指定します。

取得したメッセージ文字列に書式文字列が指定されている場合、 引数 args に置換文字列を与えることでフォーマットを行う ことができます。このとき、取得したメッセージ文字列に指定された書式文字列と 置換文字列の数が合致しない場合、例外がスローされます。

Exceptions
ExceptionCondition
ArgumentNullException 以下のような場合に例外をスローします。
  • messageId が null 参照です。
  • args が null 参照です。

ArgumentException messageId が空文字列です。
InvalidOperationException アプリケーション構成ファイルに RESOURCE_NAME_PREFIX をプレフィックスとした キーを持つエントリが存在しません。
TerasolunaException 以下のような場合に例外をスローします。
  • RESOURCE_NAME_PREFIX をプレフィックスとしたキーとする構成ファイルの appSettings 要素の value 属性値は空文字です。
  • RESOURCE_NAME_PREFIX をプレフィックスとしたキーとする構成ファイルの appSettings 要素の value 属性値の型を取得できません。
  • MessageManager 派生クラスのインスタンスを生成できません。
  • 構成ファイルの RESOURCE_NAME_PREFIX をキーとして取得するvalue値から生成できるリソース型で、 使用できるリソースのセットを見つけることができません。
  • 構成ファイルの RESOURCE_NAME_PREFIX をキーとして取得するvalue値から生成できるリソース型に、 文字列以外のリソースが保存されています。

ConfigurationErrorsException 構成ファイルが不正です。
FormatException format が無効です。または書式設定する引数を示す数が 0 より小さいか、 書式設定する指定されたオブジェクトの数以上です。

Assembly: TERASOLUNA.Fw.Common (Module: TERASOLUNA.Fw.Common) Version: 2.1.0.1 (2.1.0.1)