libcollection 0.6.2
Loading...
Searching...
No Matches

Macros

#define COL_TRAVERSE_SHOWSUB   0x00010000
 Include headers of sub collections.
 
#define COL_TRAVERSE_ONLYSUB   0x00020000
 Show sub collections.
 

Detailed Description

Note
NOTE: These flags ignored by traverse functions and can be used only in the iterator.

Macro Definition Documentation

◆ COL_TRAVERSE_SHOWSUB

#define COL_TRAVERSE_SHOWSUB   0x00010000

Include headers of sub collections.

When one collection is embedded or referenced by another collection there are two names we can be interested in. The name of the property that defines the reference and the name of the embedded collection. It is recommended that they be the same, however there may be cases when the name of the referencing property and referenced collection should be different. By default only the name of the referencing property is returned while iterating through the collection and its sub collections. Specifying this flag would cause the names of the collection (header elements) be included into the iteration process.

Flag is ignored if the COL_TRAVERSE_ONELEVEL flag is specified and not ignored. Flag is ignored is also ignored if the FLAT flag is specified.

◆ COL_TRAVERSE_ONLYSUB

#define COL_TRAVERSE_ONLYSUB   0x00020000

Show sub collections.

Show the header of the sub collection instead of the reference. Flag is ignored if the COL_TRAVERSE_ONELEVEL flag is specified and not ignored. Flag is ignored is also ignored if the FLAT flag is specified.