messages, classe

Le modèle de classe décrit un objet qui peut servir de facette de paramètres régionaux pour récupérer des messages localisés à partir d’un catalogue de messages internationalisés pour des paramètres régionaux donnés.

Actuellement, lorsque la classe de messages est implémentée, il n'y a aucun message.

Syntaxe

template <class CharType>
class messages : public messages_base;

Paramètres

CharType
Type utilisé dans un programme pour encoder des caractères dans des paramètres régionaux spécifiques.

Notes

Comme avec n'importe quelle facette de paramètres régionaux, l'ID d'objet statique possède une valeur stockée initiale de zéro. La première tentative d’accès à sa valeur stockée entraîne le stockage d’une valeur positive unique dans id.

Cette facette ouvre un catalogue de messages définis dans la classe de base messages_base, récupère les informations requises et ferme le catalogue.

Constructeurs

Constructeur	Description
messages	Fonction constructeur de facette de message.

Typedefs

Nom de type	Description
char_type	Type de caractère utilisé pour afficher les messages.
string_type	Type qui décrit une chaîne de type basic_string qui contient des caractères de type CharType.

Fonctions Membre

Fonction membre	Description
close	Ferme le catalogue de messages.
do_close	Fonction virtuelle appelée pour fermer le catalogue de messages.
do_get	Fonction virtuelle appelée pour récupérer le catalogue de messages.
do_open	Fonction virtuelle appelée pour ouvrir le catalogue de messages.
get	Récupère le catalogue de messages.
open	Ouvre le catalogue de messages.

Spécifications

Header :<locale>

Espace de noms : std

messages ::char_type

Type de caractère utilisé pour afficher les messages.

typedef CharType char_type;

Notes

Le type est un synonyme du paramètre de modèle CharType.

messages ::close

Ferme le catalogue de messages.

void close(catalog _Catval) const;

Paramètres

_Catval
Catalogue à fermer.

Notes

La fonction membre appelle do_close(_ Catval).

messages ::d o_close

Fonction virtuelle appelée pour fermer le catalogue de messages.

virtual void do_close(catalog _Catval) const;

Paramètres

_Catval
Catalogue à fermer.

Notes

La fonction membre protégée ferme le catalogue de messages _Catval, qui doit avoir été ouverte par un appel antérieur à do_open.

_Catval doit être obtenu à partir d’un catalogue précédemment ouvert qui n’est pas fermé.

Exemple

Consultez l’exemple relatif à close, qui appelle do_close.

messages ::d o_get

Fonction virtuelle appelée pour récupérer le catalogue de messages.

virtual string_type do_get(
    catalog _Catval,
    int _Set,
    int _Message,
    const string_type& _Dfault) const;

Paramètres

_Catval
Valeur d’identification spécifiant le catalogue de messages dans lequel rechercher.

_Poser
Premier identificateur utilisé pour localiser un message dans un catalogue de messages.

_Message
Deuxième identificateur utilisé pour localiser un message dans un catalogue de messages.

_Dfault
Chaîne à retourner en cas d’échec.

Valeur de retour

Elle retourne une copie de _Dfault en cas d’échec. Sinon, retourne une copie de la séquence de message spécifiée.

Notes

La fonction membre protégée tente d’obtenir une séquence de messages à partir du catalogue de messages _Catval. Il peut utiliser des _Set, des _Message et des _Dfault dans ce cas.

Exemple

Consultez l’exemple relatif à get, qui appelle do_get.

messages ::d o_open

Fonction virtuelle appelée pour ouvrir le catalogue de messages.

virtual catalog do_open(
    const string& _Catname,
    const locale& _Loc) const;

Paramètres

_Catname
Nom du catalogue dans lequel rechercher.

_Loc
Paramètres régionaux recherchés dans le catalogue.

Valeur de retour

Retourne une valeur inférieure à zéro en cas d’échec. Dans le cas contraire, la valeur retournée peut être utilisée comme premier argument lors d’un appel ultérieur à get.

Notes

La fonction membre protégée tente d’ouvrir un catalogue de messages dont le nom est _Catname. Il peut utiliser les paramètres régionaux _Loc dans ce cas

La valeur de retour doit être utilisée comme argument lors d’un appel ultérieur à close.

Exemple

Consultez l’exemple relatif à open, qui appelle do_open.

messages ::get

Récupère le catalogue de messages.

string_type get(
    catalog _CatVal,
    int _Set,
    int _Message,
    const string_type& _Dfault) const;

Paramètres

_Catval
Valeur d’identification spécifiant le catalogue de messages dans lequel rechercher.

_Poser
Premier identificateur utilisé pour localiser un message dans un catalogue de messages.

_Message
Deuxième identificateur utilisé pour localiser un message dans un catalogue de messages.

_Dfault
Chaîne à retourner en cas d’échec.

Valeur de retour

Elle retourne une copie de _Dfault en cas d’échec. Sinon, retourne une copie de la séquence de message spécifiée.

Notes

La fonction membre retourne do_get( _Catval, _Set, _Message, _Dfault).

messages ::messages

Fonction constructeur de facette de message.

explicit messages(
    size_t _Refs = 0);

protected: messages(
    const char* _Locname,
    size_t _Refs = 0);

Paramètres

_Refs
Valeur entière qui sert à spécifier le type de gestion de la mémoire pour l’objet.

_Locname
Nom des paramètres régionaux.

Notes

Les valeurs possibles pour le paramètre _Refs et leur signification sont les suivantes :

• 0 : la durée de vie de l’objet est gérée par les paramètres régionaux qui le contiennent.

• 1 : la durée de vie de l’objet doit être gérée manuellement.

• > 1 : Ces valeurs ne sont pas définies.

Aucun exemple direct n’est possible, car le destructeur est protégé.

Le constructeur initialise son objet de base avec locale::facet( _Refs).

messages ::open

Ouvre le catalogue de messages.

catalog open(
    const string& _Catname,
    const locale& _Loc) const;

Paramètres

_Catname
Nom du catalogue dans lequel rechercher.

_Loc
Paramètres régionaux recherchés dans le catalogue.

Valeur de retour

Retourne une valeur inférieure à zéro en cas d’échec. Dans le cas contraire, la valeur retournée peut être utilisée comme premier argument lors d’un appel ultérieur à get.

Notes

La fonction membre retourne do_open( _Catname, _Loc).

messages ::string_type

Type qui décrit une chaîne de type basic_string qui contient des caractères de type CharType.

typedef basic_string<CharType, Traits, Allocator> string_type;

Notes

Le type décrit une spécialisation du modèle de classe basic_string dont les objets peuvent stocker des copies des séquences de messages.

Voir aussi

<locale>
messages_base, classe
Sécurité des threads dans la bibliothèque C++ Standard