formZ SDK | 5.0 API Reference | Project | Modeling | Attributes

# fz_objt_attr_get_field_value

Description

Gets the value of a field of an attribute, which is assigned to an object The attribute is identified the prototype pointer, which can be retrieved from the attributes name by calling . The field is identified by its index. If the object does not have an attribute of the given type assigned to it, an error is returned.

Plugin Prototype

fzrt_error_td fz_objt_attr_get_field_value(

fzrt_int | windex,
fz_objt_ptr | obj,
fz_attr_proto_ptr | attr_proto,
fzrt_int | field_indx,
fz_type_td * | fz_data )

Parameters

windex [Input]

project window index

obj [Input]

the object, from which to retrieve the attribute field value

attr_proto [Input]

The attribute prototype pointer

field_indx [Input]

The index of the attribute field

fz_data [Result]

The value of the attribute field

Returns

error

Availability

5.0.0.0

Function Set

fz_objt_attr_fset

Defined in

fz_objt_attr_api.h