C_GetTimeHistory2

Call C_GetTimeHistory2 to extract time history results. To find the corresponding simulation times, call C_GetSampleTimes.

void C_GetTimeHistory2(

TOrcFxAPIHandle ObjectHandle,

const TObjectExtra2 *lpObjectExtra,

const TPeriod *lpPeriod,

int VarID,

double *lpValues,

int *lpStatus

);

Parameters

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.

lpPeriod (IN)

Points to a TPeriod variable which specifies the period of the simulation over which results are to be extracted. If the PeriodNum member of lpPeriod is set to pnStaticState then this function call is identical to C_GetStaticResult2.

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 this period, obtained by calling C_GetNumOfSamples. 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_GetTimeHistory2W and the ANSI function name is C_GetTimeHistory2A.