除非设置了 TS_SCAN_HIDDEN,否则 ts_hide_elem() 函数将给定时间戳记处的元素标记为对扫描不可见。
语法
ts_timeseries
ts_hide_elem(ts_tsdesc *tsdesc,
mi_datetime *tstamp)
- tsdesc
- ts_open() 为源时间系列返回的时间系列描述符。
- tstamp
- 要对扫描不可见的时间戳记。
描述
当元素被隐藏时,元素检索 API 函数(如
ts_elem() 和
ts_nth_elem())将返回隐藏的元素;但其
STATUS 参数会设置 TS_NULL_HIDDEN 位。元素的
STATUS 参数的值为:
- 如果 STATUS 为 TS_NULL_HIDDEN,那么将隐藏元素。
- 如果 STATUS 为 TS_NULL_NOTALLOCED,那么元素为 NULL。
- 如果 STATUS 同时为 TS_NULL_HIDDEN 和 TS_NULL_NOTALLOCED,那么元素会被隐藏且为 NULL。
- 如果 STATUS 为 0(零),那么元素不隐藏,且不为 NULL。
提供的 TS_ELEM_HIDDEN 和 TS_ELEM_NULL 宏可用于检查 STATUS 的值。
隐藏的元素无法修改;必须首先使用 ts_reveal_elem() 显示这些元素。
等效 SQL 函数是 HideElem。
返回结果
修改的时间系列。如果给定的时间戳记处没有元素,那么将发生错误。