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

# fzrt_fzr_get_string

Description

Gets a string from a resource file. This will load a string from the specified resource file, that is located in resource ID list_id and at the 1-based index. String resources are labeled as STR# in the resource file. The result is a C string in the default character set.

Plugin Prototype

fzrt_error_td fzrt_fzr_get_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

pointer to the string. Same as parameter "str", NULL if not found.

Availability

5.0.0.0

See Also

fzrt_fzr_open

Function Set

fz_fzrt_base_fset

Defined in

fzrt_api.h