Ovis_Layer_Child_Decoration_Nth()
Abstract
Returns the n-th child decoration from a layer.
Syntax
Ovis_Layer_Child_Decoration_Nth (layer_ptr, index)
| Argument | Type | Description |
|---|---|---|
layer_ptr |
OvisT_Layer * |
Layer |
index |
unsigned int |
Index number |
Return Type
OvisT_Decoration *
Decoration, if the index is within the count of children; OPC_NIL otherwise.
Header
ovis_layer.h
Details
This function returns the n-th child decoration associated with the layer.
Example
OvisT_Layer * layer_ptr;
unsigned int count, i;
OvisT_Decoration * dec_ptr;
/* …layer created elsewhere */
count = Ovis_Layer_Child_Decoration_Count (layer_ptr);
for (i = 0; i < count; i++)
{
dec_ptr = Ovis_Layer_Child_Decoration_Nth (layer_ptr, i);
/* … do something with decoration */
}
Errors
Layer is NIL.
Reference
Use the function Ovis_Layer_Child_Decoration_Count() to retrieve the number of child decorations of a layer.