C_GetTimeHistoryCollated

Call C_GetTimeHistoryCollated to extract collated time history results. To find the corresponding simulation times, call C_GetSampleTimesCollated.

void C_GetTimeHistoryCollated(

TOrcFxAPIHandle CollatedResultsHandle,

TOrcFxAPIHandle ObjectHandle,

const TObjectExtra2 *lpObjectExtra,

int VarID,

double *lpValues,

int *lpStatus

);

Parameters

CollatedResultsHandle (IN)

The collated results handle obtained by calling C_CreateCollatedResultsAdmin.

ObjectHandle (IN)

The handle of the object for which you want time history results.

lpObjectExtra (IN)

Points to a TObjectExtra2 variable which specifies where on the object results are required. Can be NULL if no additional information is needed.

VarID (IN)

Specifies the OrcaFlex variable for which the time history results are requested. Call C_GetVarID to obtain a VarID from a variable name.

lpValues (OUT)

Points to an array of double of length N, where N is the number of samples for the specified collated results. (N can be obtained by calling C_GetNumOfSamplesCollated.) The function populates the array with the N sample values.

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_GetTimeHistoryCollatedW and the ANSI function name is C_GetTimeHistoryCollatedA.