prg_profile_data_entry_get_bt()
摘要
从 profile 中获取单个数据条目(按索引),并受时间约束。
语法
prg_profile_data_entry_get_bt (profile_handle, start_time, options, n, entry_ptr)
| 参数 | 类型 | 说明 |
|---|---|---|
profile_handle |
PrgT_Profile_Handle |
要从中获取数据条目的 profile 的句柄。 |
start_time |
PrgT_Date |
考虑数据条目的起始时间。 |
options |
int |
数据选项(见详情中的 options 参数)。 |
n |
unsigned int |
所请求数据条目的索引。 |
entry_ptr |
PrgT_Profile_Data_Entry * |
用于存放所请求数据条目的内存。 |
返回类型
PrgT_Compcode
如果任何参数无效或无法获取数据条目,返回 PrgC_Compcode_Failure;否则返回 PrgC_Compcode_Success。
头文件
prg_profile_funcs.h
详情
此函数获取满足指定时间约束的第 n 个数据条目,其中 0 <= n <= (条目数 – 1)。如果 start_time 为 PRGC_DATE_VALUE_UNDEFINED,则考虑 profile 中的所有数据条目。否则,函数只考虑时间(x 值)等于或晚于 start_time 的数据条目。
默认情况下,只返回已定义的数据 (y) 值。如果所请求数据条目的 y 值未定义,函数将返回最近一个已知的已定义 y 值(如果存在),否则返回 0.0。
options 参数
options 必须是 PRGC_PROFILE_DATA_OPT_NONE,或者是以下一个或多个选项的按位或(OR)组合:
PRGC_PROFILE_DATA_OPT_TIME_ABS——时间将被转换为实时日期值返回,表示为自 1970 年 1 月 1 日以来的秒数。(默认的 x 值是相对时间。)PRGC_PROFILE_DATA_OPT_INCLUDE_UNDEFINED——函数返回所请求数据条目的 y 值,无论该值是否已定义。
注意: 要获得已弃用函数 prg_profile_data_entry_get() 的功能,请在调用此函数时将 start_time 设为 PRGC_DATE_VALUE_UNDEFINED,并将 options 设为 PRGC_PROFILE_DATA_OPT_NONE。