Ovis_Entity_Hname_Get()
摘要
检索 Ovis 实体的完整层次名称。
语法
Ovis_Entity_Hname_Get (ent_ptr, buf_len_ptr, hname_buffer)
| 参数 | 类型 | 说明 |
|---|---|---|
ent_ptr |
OvisT_Entity * |
实体 |
buf_len_ptr |
size_t * |
缓冲区最大长度(字节) |
hname_buffer |
char * |
用于存放所生成层次名称的字符缓冲区 |
返回类型
OvisT_Compcode
若成功返回层次名称则为 OvisC_Compcode_Success,否则为 OvisC_Compcode_Failure。如果检索失败是由于缓冲区大小过小,buf_len_ptr 将被设置为成功检索所需的最小大小。
头文件
ovis_entity.h
详情
该函数检索 Ovis 实体的完整层次名称。
示例
OvisT_Entity * entity;
size_t size;
char buffer [100];
/* … entity created at some point */
size = 100;
Ovis_Entity_Hname_Get (entity, &size, buffer);
错误
- 实体为 NIL。
- 大小参数为 NIL。
- 字符串缓冲区为 NIL。
参考
- 无