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

# fzrt_fzr_open

Description

Opens a formZ Resource File. This will open the resource file with the specified "base" filename. The resource reference that is returned represents collection of resources in two different languages. This function will open up to 2 formZ resource files named from the base name, in the form base_filename.XXY.fzr : where XX is a 2 letter code defined by ISO standard 639 and Y is a letter code for the sub language as defined by Microsoft Windows
ENU - US English
FRA - France
DEU - German
ESP - Spain
ELL - Greek
ITA - Italy
JPN - Japan (Hirigana, Katakana, Kanji)
CHS - Chinese Simplified (PRC)
CHT - Chinese Traditional (Taiwan)
KOR - Korean (Hangul, Hanja)
The language is determined by the current language as set in the preferences. The default current language is the language. The alternate language of the pair of resource files is always U.S. English.
Resource access functions that take a resource reference as input will search the primary file first, if that search fails, the default language file is searched (US English). If there is already an existing(open) resource reference for the file, the existing reference is returned.
If neither the primary language file nor US English language file is found, the function will fail and return an error. This function succeeds if either file is opened successfully.

Plugin Prototype

fzrt_error_td fzrt_fzr_open(

const fzrt_floc_ptr | floc,
const char * | base_fname,
fzrt_fzr_ref_td * | fzrf_ref )

Parameters

floc [Input]

file locator of the folder to find resource file

base_fname [Input]

base filename of the resource file as a C string

fzrf_ref [Result]

reference to the resource file

Returns

FZRT_NOERR on successful open
FZRT_ERR_NOT_FZRF_FILE if either of the files is not a FZRF file.
error ID otherwise

Availability

5.0.0.0

See Also

, fzrt_lang_get

Function Set

fz_fzrt_base_fset

Defined in

fzrt_api.h