messages クラス
このクラス テンプレートは、特定のロケールの国際化メッセージのカタログからローカライズされたメッセージを取得するためにロケールのファセットとして使用できるオブジェクトを表します。
現在、messages クラスは実装されていますが、メッセージはありません。
構文
template <class CharType>
class messages : public messages_base;
パラメーター
CharType
ロケールの文字をエンコードするためにプログラム内で使用される型。
解説
すべてのロケールのファセットと同様、静的オブジェクト ID に最初に格納されている値は 0 です。 格納されている値に初めてアクセスしようとすると、id に一意の正の値が格納されます。
このファセットは基本的に基底クラスの messages_base で定義されているメッセージのカタログを開き、必要な情報を取得し、カタログを閉じます。
コンストラクター
| コンストラクター | 説明 |
|---|---|
| messages | メッセージのファセット コンストラクター関数。 |
Typedefs
| 型名 | 説明 |
|---|---|
| char_type | メッセージを表示するために使用される文字型。 |
| string_type | basic_string 型の文字を格納する CharType 型の文字列を表す型。 |
メンバー関数
| メンバー関数 | 説明 |
|---|---|
| 閉じる | メッセージ カタログを閉じます。 |
| do_close | メッセージ カタログを閉じるために呼び出される仮想関数。 |
| do_get | メッセージ カタログを取得するために呼び出される仮想関数。 |
| do_open | メッセージ カタログを開くために呼び出される仮想関数。 |
| get | メッセージ カタログを取得します。 |
| open | メッセージ カタログを開きます。 |
要件
ヘッダー: <locale>
名前空間: std
messages::char_type
メッセージを表示するために使用される文字型。
typedef CharType char_type;
解説
この型は、テンプレート パラメーター CharType のシノニムです。
messages::close
メッセージ カタログを閉じます。
void close(catalog _Catval) const;
パラメーター
_Catval
終了するカタログ。
解説
メンバー関数は、do_close(_ Catval) を呼び出します。
messages::d o_close
メッセージ カタログを閉じるために呼び出される仮想関数。
virtual void do_close(catalog _Catval) const;
パラメーター
_Catval
終了するカタログ。
解説
プロテクト メンバー関数は、メッセージ カタログ _Catval を閉じます。メッセージ カタログは、do_open への事前の呼び出しで開かれている必要があります。
_Catval は、以前に開かれ、まだ閉じていないカタログから取得する必要があります。
例
close の例 (do_close を呼び出す) を参照してください。
messages::d o_get
メッセージ カタログを取得するために呼び出される仮想関数。
virtual string_type do_get(
catalog _Catval,
int _Set,
int _Message,
const string_type& _Dfault) const;
パラメーター
_Catval
検索されるメッセージ カタログを示す識別値。
_Set
メッセージ カタログ内のメッセージの検索に使用される最初の識別値。
_Message
メッセージ カタログ内のメッセージの検索に使用される 2 番目の識別値。
_Dfault
失敗した場合に返される文字列。
戻り値
失敗した場合は、_Dfault のコピーを返します。 それ以外の場合は、指定したメッセージ シーケンスのコピーを返します。
解説
プロテクト メンバー関数は、メッセージ カタログ _Catval からメッセージ シーケンスを取得しようとします。 その際に、_Set、_Message、および _Dfault を使用する場合があります。
例
get の例 (do_get を呼び出す) を参照してください。
messages::d o_open
メッセージ カタログを開くために呼び出される仮想関数。
virtual catalog do_open(
const string& _Catname,
const locale& _Loc) const;
パラメーター
_Catname
検索されるカタログの名前。
_Loc
カタログ内で検索されるロケール。
戻り値
失敗した場合、0 より小さい値を返します。 それ以外の場合は、後で get を呼び出すときに、この戻り値を最初の引数として使用できます。
解説
プロテクト メンバー関数は、名前が _Catname であるメッセージ カタログを開こうとします。 その際に、ロケール _Loc を使用する場合があります。
後で close を呼び出すときに、この戻り値を引数として使用する必要があります。
例
open の例 (do_open を呼び出す) を参照してください。
messages::get
メッセージ カタログを取得します。
string_type get(
catalog _CatVal,
int _Set,
int _Message,
const string_type& _Dfault) const;
パラメーター
_Catval
検索されるメッセージ カタログを示す識別値。
_Set
メッセージ カタログ内のメッセージの検索に使用される最初の識別値。
_Message
メッセージ カタログ内のメッセージの検索に使用される 2 番目の識別値。
_Dfault
失敗した場合に返される文字列。
戻り値
失敗した場合は、_Dfault のコピーを返します。 それ以外の場合は、指定したメッセージ シーケンスのコピーを返します。
解説
メンバー関数は、do_get( _Catval, _Set, _Message, _Dfault) を返します。
messages::messages
メッセージのファセット コンストラクター関数。
explicit messages(
size_t _Refs = 0);
protected: messages(
const char* _Locname,
size_t _Refs = 0);
パラメーター
_Refs
オブジェクトのメモリ管理の種類を指定するために使用する整数値。
_Locname
ロケールの名前。
解説
_Refs パラメーターの可能な値とその重要性は次のとおりです。
0: オブジェクトの有効期間はそれが含まれるロケールによって管理されます。
1: オブジェクトの有効期間を手動で管理する必要があります。
> 1: これらの値は定義されていません。
デストラクターが保護されているため、利用できる直接的な例はありません。
コンストラクターは、locale::facet( _Refs) を使用して、その基本オブジェクトを初期化します。
messages::open
メッセージ カタログを開きます。
catalog open(
const string& _Catname,
const locale& _Loc) const;
パラメーター
_Catname
検索されるカタログの名前。
_Loc
カタログ内で検索されるロケール。
戻り値
失敗した場合、0 より小さい値を返します。 それ以外の場合は、後で get を呼び出すときに、この戻り値を最初の引数として使用できます。
解説
メンバー関数は、do_open( _Catname, _Loc) を返します。
messages::string_type
basic_string 型の文字を格納する CharType 型の文字列を表す型。
typedef basic_string<CharType, Traits, Allocator> string_type;
解説
この型は、オブジェクトにメッセージ シーケンスのコピーを格納できるクラス テンプレート basic_string の特殊化を表します。