Ovis_Entity_Attr_Get_Int32()
Abstract
Retrieves an integer attribute value from the application object associated with the Ovis entity.
Syntax
Ovis_Entity_Attr_Get_Int32 (ent_ptr, attr_name, value_ptr)
| Argument | Type | Description |
|---|---|---|
ent_ptr |
OvisT_Entity * |
Ovis decoration |
attr_name |
const char * |
Attribute name |
value_ptr |
int * |
Value |
Return Type
OvisT_Compcode
OvisC_Compcode_Failure if the attribute value cannot be obtained; success otherwise.
Header
ovis_entity.h
Details
This function retrieves the integer attribute value of the application object associated with the Ovis entity.
Example
OvisT_Entity * ent_ptr;
int value;
/* Entity was created at some point */
Ovis_Entity_Attr_Get_Int32l (ent_ptr, "user id", &value);
Errors
- Entity is NIL
- Attribute name is not valid.
- Return address for integer attribute value is NIL.
Reference
- Use the function Ovis_Entity_Attr_Get_Dbl() to retrieve the value of a double attribute.
- Use the function Ovis_Entity_Attr_Get_Str() to retrieve the value of a string attribute.