C_GetMultipleTimeHistoriesCollated

C_GetMultipleTimeHistoriesCollated extracts multiple collated time history results. Using this function is usually more efficient than making multiple calls to C_GetTimeHistoryCollated.

void C_GetMultipleTimeHistoriesCollated(

TOrcFxAPIHandle CollatedResultsHandle,

int Count,

const TTimeHistorySpecification *lpSpecification,

double *lpValues,

int *lpStatus

);

Parameters

CollatedResultsHandle (IN)

The collated results handle obtained by calling C_CreateCollatedResultsAdmin.

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.

lpValues (OUT)

Points to an array of double of length Count * N, where N is the number of samples for the specified collated results, obtained by calling C_GetNumOfSamplesCollated. 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_GetMultipleTimeHistoriesCollatedW and the ANSI function name is C_GetMultipleTimeHistoriesCollatedA.

See also

C_CreateCollatedResultsAdmin, C_DestroyCollatedResultsAdmin, C_GetTimeHistoryCollated, C_GetNumOfSamplesCollated, C_GetRangeGraphCollated, C_GetSampleTimesCollated.