Ets_Tool_Nth_Info_Get()

Note: Requires OPNET Development Kit

Abstract

Returns information about an open tool window.

Syntax

Ets_Tool_Nth_Info_Get (index, dest_ptr)
Argument Type Description
index int The index of the tool window for which info is being requested.
dest_ptr EtsT_Tool_Info * The address of an EtsT_Tool_Info structure into which to write the information about the tool window.

Return Type

EtsT_Compcode

EtsC_Compcode_Failure if the "index" argument is out of range (not between 0 and Ets_Tool_Count_Get() - 1, inclusive); otherwise EtsC_Compcode_Success.

ets_api_tool.h

Details

This function returns information about a currently open tool window, selected by the index argument. The intention is that the client can iterate through all open tool windows by calling Ets_Tool_Count_Get() to get the number of tool windows, then calling this function with the index argument ranging from 0 to (count - 1).

The information is returned in a structure of type EtsT_Tool_Info, the address of which is passed to the function via the dest_ptr argument. This structure type contains the following fields:

  • short_tool_name: The base type of the tool window, as specified by the "base_type" attribute in an ETS configuration files (for example, "project").
  • full_tool_name: The title of the tool window, as specified by the "title" attribute in an ETS configuration file (for example, "Project").
  • model_name: The name of the model open in this tool window.

本站文档由 北京智网畅联科技有限公司 整理、翻译并提供 · 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