formZ SDK | 4.0 Call Back Reference | formZ Notification

# fz_notf_cbak_pref_default

Description

The default function is called by formZ once at startup (after plugin registration) and when the user resets the preferences to defaults in the preferences dialog. This function is provided so that plugins can establish default values for private data. All private data should be set to its default values and dimensional values should be set to the specified pref_units and pref_scale. It is recommended that the function should be used to get proper dimensional values (units and data scale) from default values for the specified pref_units and pref_scale. The function sets a double value to the current pref_units and pref_scale given an English and metric default unit values for a specified scale.

Plugin Prototype

fzrt_error_td fz_notf_cbak_pref_default(

fz_unit_type_enum | pref_units,
fz_unit_scale_enum | pref_scale )

Parameters

pref_units [Input]

preferences units to use. (when action == CMDS_DFLT_FLAG_TRUE_DFLTS or CMDS_DFLT_FLAG_UNIT_DFLTS)

pref_scale [Input]

preferences scale to use. (when action == CMDS_DFLT_FLAG_TRUE_DFLTS or CMDS_DFLT_FLAG_UNIT_DFLTS)

Returns

Error codes

Availability

5.0.0.0

Function Set

fz_notf_cbak_fset

Defined in

fz_notf_api.h