prg_profile_all_data_entries_get_bt()

Abstract

Obtains a reference to all entries of a profile's data set that match a time constraint.

Syntax

prg_profile_all_data_entries_get_bt (profile_handle, start_time, options, num_entries_ptr)
Argument Type Description
profile_handle PrgT_Profile_Handle Handle to the profile from which to get the data entries.
start_time PrgT_Date Start time for considering data entries.
options int Data options (see options Argument in Details).
num_entries_ptr unsigned int * Memory to be filled with the number of data entries returned.

Return Type

PrgT_Profile_Data_Entry*

Pointer to the first data entry returned.

prg_profile_funcs.h

Details

This function generates an array containing a copy of the requested data entries. The client is responsible for memory deallocation when the data is no longer needed.

If start_time is 0.0, all data entries in the profile are returned. Otherwise, the function returns only data entries with a time equal to or greater than start_time.

By default, only defined data (y) values are returned. If the y value of a data entry is undefined, the function replaces that value with the last known defined y value (if one exists) or 0.0 (if not).

options Argument

options must be PRGC_PROFILE_DATA_OPT_NONE or an OR'ed combination of one or more of the following:

  • PRGC_PROFILE_DATA_OPT_TIME_ABS—The time is returned converted to a real-time date value, expressed as the number of seconds since January 1, 1970. (The default x value is a relative time.)
  • PRGC_PROFILE_DATA_OPT_INCLUDE_UNDEFINED—The function returns the y value of each data entry, whether or not that value is defined.

Note: To get the functionality of the deprecated function prg_profile_all_data_entries_get(), call this function with start_time set to PRGC_DATE_VALUE_UNDEFINED and options set to PRGC_PROFILE_DATA_OPT_NONE.

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