AlReadTranslation()

Read a translation file into a database

Synopsis:

#include <photon/Al.h>

int AlReadTranslation( AlDataBase_t *db,
                       const char *path );

Arguments:

db
A pointer to a AlDataBase_t structure for the database, returned by AlOpenDBase().
path
The pathname of the translation file to load into the database.

Library:

phexlib

Description:

This function reads the translation file with the given path into the str_translated fields of the database, db.


Note: This function doesn't search for the file in any special directories or use any environment variables — the path is given directly to open().

Returns:

0
Success.
-1
The file couldn't be opened.
A positive number
The file contained entries that had to be ignored because they didn't match anything in the database.

Classification:

Photon

Safety:
Interrupt handler No
Signal handler No
Thread No

See also:

AlClearTranslation(), AlCloseDBase(), AlGetEntry(), AlGetSize(), AlOpenDBase(), AlSaveTranslation(), AlSetEntry(), ApCloseMessageDB(), ApGetMessage(), ApLoadMessageDB()

International Language Support chapter of the Photon Programmer's Guide