Ets_Obj_Attr_Get_Sized()
摘要
使用带长度限制的缓冲区获取给定 ETS 对象某属性的值。
语法
Ets_Obj_Attr_Get_Sized (obj_hndl, attr_name, size_ptr, val_ptr)
| 参数 | 类型 | 说明 |
|---|---|---|
obj_hndl |
EtsT_Obj_Handle |
目标对象的句柄。 |
attr_name |
const char * |
目标属性的名称。 |
size_ptr |
size_t * |
调用时为 val_ptr 的大小。返回时为属性值的实际大小(对字符串而言,包含结尾的空字符)。 |
val_ptr |
void * |
用于填充属性值的缓冲区。 |
返回类型
EtsT_Compcode
若属性存在且有效则返回 EtsC_Compcode_Success,否则返回 EtsC_Compcode_Failure。
头文件
ets_api_obj.h
详情
该函数与 Ets_Obj_Attr_Get() 类似,区别在于它带有一个大小参数,返回属性值时不会越界写坏 val_ptr 缓冲区。(若 size_ptr 为 NULL,该函数的行为与 Ets_Obj_Attr_Get() 完全相同。)
对于大于 val_ptr 的字符串属性值,返回的是截断后的字符串。对于其他数据类型,若属性值过大,val_ptr 保持不变。
size_ptr 参数让你能够检测缓冲区大小问题,并重新分配缓冲区以容纳所请求的属性值。例如:
{
char buffer [1024];
char * buffer_ptr;
size_t size;
size_t buf_size;
buffer_ptr = buffer;
size = buf_size = 1024;
status = Ets_Obj_Attr_Get_Sized (obj_h, attr_name, &size, buffer_ptr);
if ((status == EtsC_Compcode_Failure) && (buf_size < size))
{
// size includes the terminating null
buffer_ptr = malloc (size);
status = Ets_Obj_Attr_Get_Sized (obj_h, attr_name, &size, buffer_ptr);
}
if (status == EtsC_Compcode_Failure)
{
// Error.
return;
}
// Use the value.
if (buffer_ptr != buffer)
free (buffer_ptr);
}