Ovis_Entity_Attr_Get_Str()
Abstract
Retrieves a string attribute value from the application object associated with the Ovis entity
Syntax
Ovis_Entity_Attr_Get_Str (ent_ptr, attr_name, buf_size_ptr, buffer)
| Argument | Type | Description |
|---|---|---|
ent_ptr |
OvisT_Entity * |
Ovis decoration |
attr_name |
const char * |
Attribute name |
buf_size_ptr |
size_t * |
Maximum length of the buffer, in bytes |
buffer |
char * |
Character buffer in which to place the attribute value |
Return Type
OvisT_Compcode
OvisC_Compcode_Failure if the attribute value cannot be obtained; success otherwise. If the retrieval failed because the buffer size was too small, *buf_size_ptr is set to the minimum size for a successful retrieval.
Header
ovis_entity.h
Details
This function retrieves the string attribute value from the application object associated with the Ovis entity.
Example
OvisT_Entity * ent_ptr;
size_t size = 100;
char value [100];
/* Entity was created at some point */
Ovis_Entity_Attr_Get_Str (ent_ptr, "model", &size, value);
Errors
- Entity is NIL
- Attribute name is not valid.
- Size field is NIL.
- Return address for string 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_Int32() to retrieve the value of an integer attribute.