#include <errmsg.hxx>
Public Member Functions | |
| void | load () |
| This function loads the message module. | |
| message_list const * | message (int offset) const |
| Returns a pointer to the message data for an offset into a module's message list. | |
| err_mess_type | message_code (int offset) const |
| Generates an error number from an offset into a module's message list. | |
| int | message_index () |
| Returns the message module (unique) index. | |
| message_module (char const *name, message_list const *message) | |
C++ constructor, creating a message_module using the specified parameters. | |
| char ** | messageForUpdate (int idx) |
Returns the address of the char* pointer so the caller can assign their own string into the message_list. | |
| char const * | module () const |
| Returns the module's name. | |
| message_module * | next_message_module () |
| Returns the next message module. | |
| void | unload () |
| Remove this module from the linked list. | |
| ~message_module () | |
C++ destructor, deleting a message_module. | |
Static Public Member Functions | |
| static void | loadAll () |
This static function initiates load of all message_modules. | |
| static void | unloadAll () |
This static function initiates unload of all message_modules. | |
| message_module::message_module | ( | char const * | name, | |
| message_list const * | message | |||
| ) |
C++ constructor, creating a message_module using the specified parameters.
| name | name of the module. | |
| message | The array of messages for this module, terminated by an entry with a NULL identifier. |
| message_module::~message_module | ( | ) |
C++ destructor, deleting a message_module.
| void message_module::load | ( | ) |
This function loads the message module.
| static void message_module::loadAll | ( | ) | [static] |
This static function initiates load of all message_modules.
Role: Loading is handled by a message_loader which interfaces to an external database. This function does nothing if the message_module is already loaded.
| message_list const* message_module::message | ( | int | offset | ) | const |
Returns a pointer to the message data for an offset into a module's message list.
| offset | Offset into module's message list. |
| err_mess_type message_module::message_code | ( | int | offset | ) | const |
Generates an error number from an offset into a module's message list.
Role: The ACIS build tools generate a header file containing symbolic definitions of error numbers using this method.
| offset | Offset into module's message list. |
| int message_module::message_index | ( | ) | [inline] |
Returns the message module (unique) index.
| char** message_module::messageForUpdate | ( | int | idx | ) |
Returns the address of the char* pointer so the caller can assign their own string into the message_list.
| idx | list index. |
| char const* message_module::module | ( | ) | const |
Returns the module's name.
| message_module* message_module::next_message_module | ( | ) | [inline] |
Returns the next message module.
| void message_module::unload | ( | ) |
Remove this module from the linked list.
Role: If there is no previous module in the list, then the element being removed is the head element.
| static void message_module::unloadAll | ( | ) | [static] |
This static function initiates unload of all message_modules.
Role: Unloading is handled by a message_loader which interfaces to an external database. This may be used to release memory resources used by the strings.