formZ SDK | 5.0 API Reference | System | Runtime Library (FZRT) | Basic

fzrt_fzr_get_menu_string

Description

Gets a string from a menu resource. This will load a string a MENU resource from the resource file. The Menu resource is labeled with "MENU", and is the same format as a string list. The first string is the menu title. The first menu item is the second string in the list. The index parameter corresponds the index in the string list.

Plugin Prototype

fzrt_error_td fzrt_fzr_get_menu_string(

fzrt_fzr_ref_td

fzr_ref,

fzrt_unsigned_int

list_id,

fzrt_unsigned_int

index,

fzrt_ptr

str )

Parameters

fzr_ref [Input]

reference to the resource file

list_id [Input]

ID of the string resource in the file

index [Input]

1-based index to the string in the string list

Range: index >= 1

str [Result]

pointer to buffer, allocated by caller, that holds result C string

Returns

FZRT_NOERR if successful, an error ID otherwise.

Availability

5.0.0.0

See Also

fzrt_fzr_get_string

Function Set

fz_fzrt_base_fset


Defined in

fzrt_api.h