AlGetEntry()

Get an entry from a language or message database

Synopsis:

#include <photon/Al.h>

const AlTextEntry_t *AlGetEntry(
                         AlDataBase_t const *db,
                         unsigned n );

Arguments:

db

A pointer to a AlDataBase_t structure for the database, returned by AlOpenDBase().

n

The number of the record to return.

Library:

phexlib

Description:

AlGetEntry() returns the nth record from the language or message database specified by db.

The AlTextEntry_t structure contains at least the following members:

unsigned long res_flags

Bits include:

• Al_ISMESSAGE -- this record describes a message rather than a widget's resource.
• Al_MULTILINE -- multiple lines are allowed in the translation.
• Al_ACCELERATOR -- this record is a menu item accelerator.

const char *wgt_name

The widget name or message tag.

unsigned long res_value

The resource (0 for messages).

const char *res_descr

A description of the resource or message.

unsigned long res_index

For list items, it's the index (starting from 0); otherwise, 0.

const char *str_original

The original message/resource.

const char *str_translated

The translated message/resource (initially NULL).

Returns:

A pointer to the record retrieved, or NULL if there isn't a record corresponding to n.

Classification:

Photon

See also:

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

International Language Support chapter of the Photon Programmer's Guide