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.

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

本站文档由 北京智网畅联科技有限公司 整理、翻译并提供 · Documentation compiled and provided by Beijing ZNetLink Technology Co., Ltd.

交流群 · QQ Group:OPNET/智网妙算网络仿真交流群(群号 486383494)

原文档 © 2017 Riverbed Technology · 本站为公益翻译,由 AI 辅助完成,请仔细甄别

Original documentation © 2017 Riverbed Technology. Community translation, AI-assisted. Contact: jiazequn@znetlink.com