prg_file_output_files_list_get()

Abstract

Returns a list of typed files of a specific type belonging to a project-scenario.

Syntax

prg_file_output_files_list_get (type, base_name, optional_suffix)
Argument Type Description
type PrgT_Tfile_Type The tfile type. Must be one of the symbolic constants given in Table 5 “Tfile Package Symbolic Constants“ on page 152.
base_name const char * Base name of the desired files (usually the project-scenario name). If OPC_NIL, all files of type are returned.
optional_suffix const char * Optional file name suffix representing the desired run number.

Return Type

PrgT_List *

List of requested files.

prg_file_funcs.h

Details

This function searches the model directories (as listed by the “mod_dirs“ preference) and returns a list of all files that meet the specified requirements (type, base_name, and optional_suffix). This function is intended for gathering lists of output (results) files, although no type checking is performed to verify that the requested type is an output file. To get output files, set type to either PrgC_Tfile_Type_Outvector or PrgC_Tfile_Type_Anim_Hist.

A typical output file name has the form

<pj_name>-<sc_name>[-DES|FLAN[-#]]

where

  • <pj_name> is the project name
  • <sc_name> is the scenario name
  • DES|FLAN is the source (discrete event simulation or flow analysis)
  • # is the run number

The caller owns the list and is responsible for destroying both it and the list elements.

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