formZ SDK | 4.0 Call Back Reference | Renderer

fz_rndr_cbak_opts_name

Description

Gets the name of the renderer options. This function is called by formZ to get the name of the renderers options. This name shows up in the formZ interface, whenever the title of the renderers options is shown. The name function must assign a string to the function's name argument. The length of the string assigned cannot exceed max_len characters. It is recommended, that the renderer's name is stored in a .fzr resource file and retrieved from it, when assigned to the name argument, so that it can be localized for different languages.

Plugin Prototype

fzrt_error_td fz_rndr_cbak_opts_name(

char *

str_name,

fzrt_int

max_len )

Parameters

str_name [Result]

The name of the renderer, as it will appear in the Display menu.

max_len [Input]

The maximum number of characters, the name string may contain.

Returns

Error codes

Availability

5.0.0.0

Function Set

fz_rndr_cbak_fset


Defined in

fz_rndr_api.h