ApLoadMessageDB()

Load a message database

Synopsis:

ApMsgDBase_t *ApLoadMessageDB( ApMsgDBase_t *db,
                               const char *name );

Arguments:

db

NULL, or a pointer to a message database that's already open to which you want to add the loaded messages.

name

The name of the message database that you want to load.

Library:

Ap

Description:

This function loads the message database with the given name. It searches for the file based on the value of the ABLPATH and the current language:

• If a language isn't defined, the message database is loaded. It must have a name of name.mdb.
• If a language is defined, ApLoadMessageDB() looks for a translation file called name.language. Translation files can be created using PhAB translation editor -- it can handle message databases.

Note that in an application that uses PhAB DLLs, this function performs the language search based on the location of the executable or DLL associated with the current context. If there's no current context, a lookup that would search the directory of an executable or DLL is skipped.

Returns:

A pointer to the new database, or NULL if it couldn't be opened.

Classification:

Photon

See also:

AlClearTranslation(), AlCloseDBase(), AlGetEntry(), AlGetSize(), AlOpenDBase(), AlReadTranslation(), AlSaveTranslation(), AlSetEntry(), ApGetMessage()

International Language Support chapter of the Photon Programmer's Guide