prg_profile_earliest_time_get()
Abstract
Gets the earliest time of the data entries in a profile.
Syntax
prg_profile_earliest_time_get (profile_handle, options)
| Argument | Type | Description |
|---|---|---|
profile_handle |
PrgT_Profile_Handle |
Handle to the profile of interest. |
options |
int |
Data options (see options Argument in Details). |
Return Type
PrgT_Date
The earliest time in the profile, or PRGC_DATE_VALUE_UNDEFINED if no time can be obtained (for example, because profile_handle is NULL or the profile is empty or not time-based).
Header
prg_profile_funcs.h
Details
If the profile is time-based, this function returns the time (x value) of the first defined data entry (that is, the first entry with a y value). The returned time is a relative value.
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—If the profile includes a calendar start time, the returned time is converted to a real-time date value (number of seconds since January 1, 1970); if not, the returned value will still be in relative time.PRGC_PROFILE_DATA_OPT_INCLUDE_UNDEFINED—The function returns the earliest time in the profile, whether or not the y value at that time is defined.