Ovis_Entity_Hname_Get()
Abstract
Retrieves the full hierarchical name of the Ovis entity.
Syntax
Ovis_Entity_Hname_Get (ent_ptr, buf_len_ptr, hname_buffer)
| Argument | Type | Description |
|---|---|---|
ent_ptr |
OvisT_Entity * |
Entity |
buf_len_ptr |
size_t * |
Maximum length of the buffer, in bytes |
hname_buffer |
char * |
Character buffer in which to place the generated hierarchical name |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if it returns the hierarchical name; OvisC_Compcode_Failure otherwise. If the retrieval failed because the buffer size was too small, buf_len_ptr is set to the minimum size for a successful retrieval.
Header
ovis_entity.h
Details
This function retrieves the full hierarchical name of the Ovis entity.
Example
OvisT_Entity * entity;
size_t size;
char buffer [100];
/* … entity created at some point */
size = 100;
Ovis_Entity_Hname_Get (entity, &size, buffer);
Errors
- Entity is NIL.
- Size argument is NIL.
- String buffer is NIL.
Reference
- None