GetGraphPoints::GetPoints

GetPoints

Description

This method initiates the point picking process. A maximum number of point sto pick can be specified along with the specific GraphLayer to pick from.

When called, further OriginC code will pause while the point picking process is taking place. Once either the maximum number of points has been picked or the processed cancelled via the ESC key or deactivation of the target graph, this method will return.

Hint: To pick a seemingly unlimited number of points nPts parameter could be set to something very high such as 1E6.

Syntax

BOOL GetPoints(int nPts, GraphLayer &gl = NULL, LPCSTR lpcszLTvarName = NULL)

Parameters

nPts

[input] Maximum number of points to get.

gl

[input] GraphLayer object, Points are to be selected from a plot or plots this Layer.

lpcszLTvarName

[input] An optional LabTalk variable that can be used for interaction with a dialog. Not used except in certain cases.

Return

Returns non-zero if successful.

Examples

For an example of using this method, please see the Example Section in GetGraphPoints.

Remark

See Also

header to Include

origin.h