Ovis_Group_Id_Get()
Abstract
Returns the ID of the overall general group.
Syntax
Ovis_Group_Id_Get (group_ptr)
| Argument | Type | Description |
|---|---|---|
group_ptr |
OvisT_Group * |
Pointer to the overall general Ovis group |
Return Type
OvisT_Id
ID of the Ovis group; OVISC_ID_INVALID if not a valid group.
Header
ovis_entity.h
Details
This function returns the ID of the overall general Ovis group.
Example
OvisT_Group * group;
OvisT_Id id;
/* …group created elsewhere */
id = Ovis_Group_Id_Get (group);
Errors
- Group is NIL.
Reference
- None