formZ SDK | 4.0 Call Back Reference | Object Attributes

# fz_attr_cbak_get_field_data

Description

Custom attribute field info (Optional). This function is called by formZ to retrieve information about a particular attribute field. The information consists of field name, data type, default value, field format, minimum and maximum range. This information is retrieved, for example, in the Attributes Manager dialog. The index passed in needs to be interpreted by the plugin to address the proper field in the attribute. The index ranges between 0 and the value returned by fz_attr_cbak_get_field_count. Note, that it is not necessary to expose all fields of an attribute to a user in this fashion, just the ones that needs to be seen in the context of attribute and information management. The name returned by this function is also used to determine the proper reference in an expression in the Information Management dialog.

Plugin Prototype

fzrt_error_td fz_attr_cbak_get_field_data(

fzrt_int | windex,
fz_objt_ptr | obj,
void * | data,
fzrt_int | field_indx,
fz_type_td * | value )

Parameters

windex [Input]

project window index

obj [Input]

object

data [Input]

attribute data.

field_indx [Input]

The index of the field. Ranges between 0 and the number of fields reported by fz_attr_cbak_get_field_count

value [Result]

The value for this field.

Returns

error

Availability

5.0.0.0

Function Set

fz_attr_cbak_fset

Defined in

fz_objt_attr_api.h