formZ SDK | 5.0 API Reference | Project | Group Manager

fz_grup_get_leaf_tag

Description

Gets the tag to the referenced data (light, layer or object) for a leaf group ( FZ_GRUP_TYPE_LEAF). For example, if the group hierachy is for layers, the tag returned is the tag of the layer, which belongs to the leaf group.
If the group passed in is not a leaf group, an error is returned and the tag is set to a NULL tag.

Plugin Prototype

fzrt_error_td fz_grup_get_leaf_tag(

fzrt_int

windex,

fz_grup_table_ptr

gtable,

fz_grup_ptr

grup,

fz_tag_td *

tag )

Parameters

windex [Input]

project window index

gtable [Input]

group table

grup [Input]

group

tag [Result]

tag of the entity, referenced by the leaf group

Returns

Error codes

Availability

5.0.0.0

Function Set

fz_grup_fset


Defined in

fz_grup_api.h