ApGetTextRes()

Get a translated text string from a widget database

Synopsis:

#include <Ap.h>

char *ApGetTextRes( ApDBase_t const *db,
                    char const *name );

Arguments:

dbase
A pointer to a widget database that you opened with either ApOpenDBase() or ApOpenDBaseFile().
name
The instance name of the text string that you want to translate.

Library:

Ap

Description:

ApGetTextRes() extracts the translated text string from the database identified by db using name as the widget instance name identifier.

Returns:

The translated text string if successful, NULL if not found, or name or db if invalid.

Examples:

ApDBase_t *mydbase;
char  *string;

mydbase = ApOpenDBase( ABM_mypicture);
string = ApGetTextRes( mydbase, "msg1" );

Classification:

Photon

Safety:
Interrupt handler No
Signal handler No
Thread No

See also:

ApGetImageRes(), ApOpenDBase(), ApOpenDBaseFile()

Accessing PhAB Modules from Code and International Language Support chapters of the Photon Programmer's Guide