C_GetRangeGraphCurveNames

Call C_GetRangeGraphCurveNames to get display names for the curves returned by a call to C_GetRangeGraph4. These are the same names which appear in the legend for an OrcaFlex range graph.

Parameters

ObjectHandle (IN)

The handle of the object for which you want range graph results. This must be the handle of a line or turbine.

lpObjectExtra (IN)

Points to a TObjectExtra2 variable. This is only needed if:

• You want clearance results to be reported as clearances from a specified line.
• You are asking for component stress results e.g. for results variables like "von Mises Stress", "ZZ Stress", "RC Stress" etc.
• The object is a turbine.

If none of the above conditions hold, then you should pass NULL.

If you do want clearance results to be reported as clearances from a specified line then you must set the ClearanceLineName member of lpObjectExtra. Note that the other members which specify a particular point on the line or turbine blade are ignored and do not need to be set. This is because a range graph gives results for all points on the line or turbine blade.

If you are asking for component stress results then you need to specify the RadialPos and Theta members of lpObjectExtra. Note that the other members which specify a particular point on the line or turbine blade are ignored and do not need to be set. This is because a range graph gives results for all points on the line or turbine blade.

If the object is a turbine, then you need to specify the BladeIndex member of lpObjectExtra. Note that the other members which specify a particular point on the blade are ignored and do not need to be set. This is because a range graph gives results for all points on the blade.

lpPeriod (IN)

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

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.

lpCurveNames (OUT)

Points to a TRangeGraphCurveNames variable in which the display names will be returned.

Before calling C_GetRangeGraphCurveNames, set the Size member of the TRangeGraphCurveNames structure to sizeof(TRangeGraphCurveNames).

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_GetRangeGraphCurveNamesW and the ANSI function name is C_GetRangeGraphCurveNamesA.

See also

TRangeGraphCurveNames, C_GetRangeGraph4.