Osys_Env_Reports_Dir_Get()
摘要
返回生成报告的输出目录的完整路径。
语法
Osys_Env_Reports_Dir_Get (project_name, scenario_name, module_name, options, output_reports_dir)
| 参数 | 类型 | 说明 |
|---|---|---|
project_name |
const char * |
生成报告所属项目的名称 |
scenario_name |
const char * |
生成报告所属场景的名称 |
module_name |
const char* |
用于生成报告的模块名称(如有) |
options |
int |
指定二进制选项的标志。 |
output_reports_dir |
PrgT_Path |
生成的报告文件将要存储的完整路径 |
返回类型
PrgT_Compcode
如果指定路径无效、过大而无法存入传入的缓冲区,或使用了无效的输入组合,返回 PrgC_Compcode_Failure;否则返回 PrgC_Compcode_Success。
头文件
osys_env.h
详情
使用 project_name、scenario_name 与 module_name 参数返回报告目录,规则如下表所示(“—”表示传入 PRGC_NIL):
| 项目 | 场景 | 模块 | 路径 |
|---|---|---|---|
| — | — | — | <op_reports>/ |
<project> |
— | — | <op_reports>/<project>/ |
<project> |
<scenario> |
— | <op_reports>/<project>/<scenario> |
<project> |
<scenario> |
<module> |
<op_reports>/<project>/<scenario>/<module> Reports |
<project> |
— | <module> |
<op_reports>/<project>/<module> Reports |
| — | — | <module> |
<op_reports>/<module> Reports |
可以为 options 参数指定以下值之一:
OSYSC_ENV_REP_DIR_GET_OPT_NONE——默认行为是:如果路径尚不存在,则完整创建并返回该路径。OSYSC_ENV_REP_DIR_GET_OPT_DONT_CREATE_SUBDIR——如果<op_reports>下不存在子目录,则不创建子目录。(默认行为是在找不到指定子目录时创建它。)OSYSC_ENV_REP_DIR_GET_OPT_DONT_APPEND_SPACE_REPORTS——不在路径中的模块名后追加字符串 " Reports"。例如,此选项会将 output_reports_dir 设置为 “<op_reports>/<module>“ 而不是 “<op_reports>/<module> Reports”(默认行为)。
用途
任何生成报告的过程都应调用此过程,以获取顶层报告目录(由 reports_dir 首选项指定)以及正确的按项目/场景/模块划分的子目录。完整目录路径存储在 output_reports_dir 中;后续代码在保存生成的报告文件时可以引用该字符串。