C_GetRangeGraphNumOfPointsCollated

Call C_GetRangeGraphNumOfPointsCollated to find out how many points there are in a collated range graph. This is needed to allocate memory for the results of calls to C_GetRangeGraphCollated.

int C_GetRangeGraphNumOfPointsCollated(

TOrcFxAPIHandle CollatedResultsHandle,

TOrcFxAPIHandle ObjectHandle,

const TArclengthRange *lpArclengthRange,

int VarID,

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 range graph results. This must be the handle of a line or turbine.

lpArclengthRange (IN)

Points to a TArclengthRange variable which specifies the arclength ranges for which results are to be extracted. If NULL is passed then results will be extracted for the entire line or turbine blade.

VarID (IN)

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

lpStatus (OUT)

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

Return Value

The number of points in the range graph.

See also

C_GetRangeGraphCollated, C_GetRangeGraphCurveNamesCollated.