formZ SDK | 4.0 Call Back Reference | Object Attributes

# fz_attr_cbak_info

Description

Custom attribute info function (Required). This function is called at startup. It is expected to return basic information about the attribute. The info to be returned is :
size : the size of the attribute data in # of bytes.
level_flags : the levels by which the attribute is used. Attributes can be used on the face and object level and may be used by more than one level at a time. For example, the surface style attribute is used by the object and face level. The levels used by the attribute are bit encoded in the level_flags parameter. The bits are defined in fz_attr_level_enum. For example to indicate, that an attribute is used by the object and face level, the level_flags is set :
level_flags = 0;
FZ_SETBIT(*level_flags, FZ_ATTR_LEVEL_OBJT);
FZ_SETBIT(*level_flags, FZ_ATTR_LEVEL_FACE;
flags : general information about the attribute. The flags are bit encoded. The bits are defined in fz_attr_flags_enum. flags = 0;
FZ_SETBIT(*flags, FZ_ATTR_LEVEL_OBJT);
FZ_SETBIT(*flags, FZ_ATTR_LEVEL_FACE);

Plugin Prototype

fzrt_error_td fz_attr_cbak_info(

fzrt_int * | size,
fzrt_int * | level_flags,
fzrt_int * | flags )

Parameters

size [Result]

The size of the attribute data in # of bytes.

level_flags [Result]

Bit encoded levels which use the attribute.

flags [Result]

Bit encoded flags, which tell formZ basic information about the attribute.

Returns

error

Availability

5.0.0.0

Function Set

fz_attr_cbak_fset

Defined in

fz_objt_attr_api.h