C_GetMultipleTimeHistories

C_GetMultipleTimeHistories extracts multiple time history results. Using this function is usually more efficient than making multiple calls to C_GetTimeHistory2.

void C_GetMultipleTimeHistories(

int Count,

const TTimeHistorySpecification *lpSpecification,

const TPeriod *lpPeriod,

double *lpValues,

int *lpStatus

);

Parameters

Count (IN)

The number of time histories to be extracted.

lpSpecification (IN)

Points to an array of TTimeHistorySpecification structures, of length Count, that specify which time histories are to be extracted.

lpPeriod (IN)

Points to a TPeriod variable which specifies the period of the simulation over which results are to be extracted.

lpValues (OUT)

Points to an array of double of length Count * N, where N is the number of samples for this period, obtained by calling C_GetNumOfSamples. The function populates the array with the time history values.

The output array is populated as a 2D array with time as the outer dimension. In other words, the time history value for variable varIndex and time sample sampleIndex is given by:

lpValues[varIndex + sampleIndex * Count]

where 0 ≤ varIndex < Count and 0 ≤ sampleIndex < N.

lpStatus (OUT)

Points to a variable in which the status result for the function call will be returned.

Unicode and ANSI

The Unicode function name is C_GetMultipleTimeHistoriesW and the ANSI function name is C_GetMultipleTimeHistoriesA.