Warning: main(/www/www/htdocs/style/globals.php) [function.main]: failed to open stream: No such file or directory in /www/www/docs/6.4.1/photon/lib_ref/ap/apgetitemtext.html on line 1

Warning: main() [function.include]: Failed opening '/www/www/htdocs/style/globals.php' for inclusion (include_path='.:/www/www/common:/www/www/php/lib/php') in /www/www/docs/6.4.1/photon/lib_ref/ap/apgetitemtext.html on line 1

Warning: main(/www/www/htdocs/style/header.php) [function.main]: failed to open stream: No such file or directory in /www/www/docs/6.4.1/photon/lib_ref/ap/apgetitemtext.html on line 8

Warning: main() [function.include]: Failed opening '/www/www/htdocs/style/header.php' for inclusion (include_path='.:/www/www/common:/www/www/php/lib/php') in /www/www/docs/6.4.1/photon/lib_ref/ap/apgetitemtext.html on line 8

ApGetItemText()

Get the text for a menu item

Synopsis:

#include <Ap.h>

char * ApGetItemText( ApMenuLink_t *menu,
                      int item_name);

Arguments:

menu
A pointer to a PhAB menu link structure.
item_name
The ABN_ name of the menu item, as generated by PhAB.

Library:

Ap

Description:

ApGetItemText() is used to extract the text of a menu item in a PhAB menu module. If a language translation is in effect, the translated string is returned rather than the default text built into the application.

Returns:

A pointer to a text string or translated text, or NULL if the ABN_ name is invalid.


Caution: Don't free the returned text string, or your application will crash.

If you call ApModifyItemText() after calling ApGetItemText() for the same menu item, the string returned by ApGetItemText() becomes invalid.

Examples:

text = ApGetItemText( &mymenu, ABN_item1 );

Classification:

Photon

Safety:
Interrupt handler No
Signal handler No
Thread No

See also:

ApModifyItemAccel(), ApModifyItemState(), ApModifyItemText()

Changing menu-item text in the Working with Code chapter of the Photon Programmer's Guide


Warning: main(/www/www/htdocs/style/footer.php) [function.main]: failed to open stream: No such file or directory in /www/www/docs/6.4.1/photon/lib_ref/ap/apgetitemtext.html on line 134

Warning: main() [function.include]: Failed opening '/www/www/htdocs/style/footer.php' for inclusion (include_path='.:/www/www/common:/www/www/php/lib/php') in /www/www/docs/6.4.1/photon/lib_ref/ap/apgetitemtext.html on line 134