op_ima_obj_attr_get_str_sized()

Abstract

Obtains the value of a string attribute in the specified object, using a sized buffer.

Syntax

op_ima_obj_attr_get_str_sized (objid, attr_name, size_ptr, value_buffer)
Argument Type Description
objid Objid object ID of the object-of-interest
[An object ID can be obtained from several KPs in the Topo and Id packages: op_id_self(), op_topo_parent(), op_topo_child(), op_id_from_userid(), and op_id_from_name().]
attr_name const char * name of the attribute-of-interest
[This attribute must be of type string and defined in the specified object, or an error will occur.]
size_ptr size_t * On call, pointer to the size of value_buffer (including space for the ending '\0').
On return, the actual size of the attribute value in value_buffer.
value_buffer char * pointer to a variable to be filled with the specified attribute’s value (maximum length of value is size_ptr – 1 characters)

Return Type

Compcode

OPC_COMPCODE_SUCCESS if the attribute value was successfully obtained; OPC_COMPCODE_FAILURE otherwise.

Example

{
char      tx_nodename [128];
char *    buffer_ptr;
size_t    size;
Compcode  status;

buffer_ptr = tx_nodename;
size = 128;
tx_nodeid = op_id_parent (op_td_get_int (pkptr, OPC_TDA_RA_TX_OBJID));
status = op_ima_obj_attr_get_str_sized (tx_nodeid, "name", &size, tx_nodename);
}

Details

This function is similar to op_ima_obj_attr_get_str(), except that it has a size argument and will not overrun value_buffer when returning the attribute value. For string attribute values that are larger than value_buffer, a truncated string is returned.

Purpose

Provides a mechanism to dynamically obtain object attributes during the course of the simulation. This KP works identically to op_ima_obj_attr_get(), but applies only to object attributes of data type string. Refer to op_ima_obj_attr_get() for full purpose and details.

Errors

  • Same as op_ima_obj_attr_get(), plus the following:
  • Program Abort: Attribute (<name>) is of type (<type>). Can’t get its value as type (string).

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