System CATMsg

Usage: you must use this class as is. You should never derive it.

public class CATMsg

Message from a message catalog.
Role: Processing a message from a message catalog (see ). A message is the unit cell that is the a message of a message catalog (see ). A message is a parameterized alphanumerical string which can be used for any alphanumerical item of information, a warning, a help or error message, and whenever you need to display any text in a dialog window, such a the caption on a push button. NLS (National Langage Support) is supported.

Syntaxically, a CATMsg object (which can be, as you can see in its syntax below, constructed simply calling the CATMsg class constructor, with no argument), corresponds precisely to an access to the message itself.

A given message of a message catalog contains a key. This key identifies a message. For example, the method, to substitute a message in a given message catalog, takes as the input message identifier its key.

Regarding the parameters of a message, you reference them through a syntax of the following form: A parameter begins with /p or /P in the message text. The following are examples of messages: 

 Message1 = "This is a simple message.";
 Message2 = "This message includes the parameter /P1 that
             is valued by your application at run-time.";
 Message3 = "This is a", "compound ", "message.";
 Message4 = "You can use control characters such as \t or \n in your messages.";
Messages can be easily translated, since they are stored outside of the code that handles them.
see
see

Constructor and Destructor Index


o CATMsg()
Constructs an empty message.
o CATMsg(CATMsg&)
Copy constructor.
o CATMsg(CATUnicodeString&)
Constructs a CATMsg instance from a CATUnicodeString instance.
o ~CATMsg()

Method Index


o operator=(CATMsg&)
Assignment operator.

Constructor and Destructor


o CATMsg
public CATMsg()
Constructs an empty message.
Caution: This method should rarely be used, in most cases the use of is enough.
o CATMsg
public CATMsg( const iMessage)
Copy constructor.
Caution: This method should rarely be used, in most cases the use of is enough.
Parameters:
iMessage
The message to copy
o CATMsg
public CATMsg( const iString)
Constructs a CATMsg instance from a CATUnicodeString instance.
Caution: This method should rarely be used, in most cases the use of is enough.
o ~CATMsg
public ~CATMsg()

Methods


o operator=
public operator=( const iMessage)
Assignment operator.
Caution: This method should rarely be used, in most cases the use of is enough.
Parameters:
iMessage
Message of the right part of the equality
Returns:
Message of the left part of the equality
This object is included in the file: CATMsg.h
If needed, your Imakefile.mk should include the module: JS0GROUP

Copyright © 1999-2015, Dassault Systèmes. All rights reserved.