ApGetMessage()

Get a message from a message database

Synopsis:

char *ApGetMessage( ApMsgDBase_t *db,
                    const char *tag );

Arguments:

db
A pointer to a message database, returned by ApLoadMessageDB().
tag
The tag for the message that you want to get.

Library:

Ap

Description:

A message database is a file containing textual messages. ApGetMessage() can be used to retrieve the message with the given tag from the database specified by db.

Returns:

The message corresponding to the tag, or NULL if the tag wasn't found in the database.


Note: Don't change the message string.

Classification:

Photon

Safety:
Interrupt handler No
Signal handler No
Thread No

See also:

ApCloseMessageDB(), ApLoadMessageDB()

International Language Support chapter of the Photon Programmer's Guide