ITrendCursor​.GetValue [Method]

Gets the value at the cursor for the given pen.

Defined As

• [VBA] GetValue(pen As Object, asLocal As Boolean, time As Date, milli As Integer, value As String)

• [Cicode] GetValue(OBJECT pen, INT asLocal, REAL time, INT milli, STRING value)

• [C++] HRESULT Create GetValue(IPen* pen, VARIANT_BOOL asLocal, DATE *time, short *milli, BSTR *value)

Parameters

pen

[in] The pen for which the value is necessary.

asLocal

[in] Set to True (-1) if returned time is necessary in Local form (False (0) for UTC).

time

[out] The time represented by the cursor position. This is accurate to one second and needs to be combined with milli to give millisecond accuracy.

milli

[out] Added to time (see above) to give cursor time in millisecond accuracy.

value

[out] The value of the trend for the given pen at the returned time.

Execution Result

If the function succeeds, the return value will be Success. If one of the return variables are bad, then the return value will be InvalidArgument. If the cursor is deleted, the return value will be GeneralFailure.

Calling Syntax

This example assumes you have a valid reference to a cursor and a pen.

[VBA]

Sub Example(cursor As Object, pen As Object)
Dim asLocal As Boolean
Dim cursorTime As Date
Dim milli As Integer
Dim cursorValue As String
asLocal = 0
cursor.GetValue pen, asLocal, cursorTime, milli, cursorValue
End Sub

[Cicode]

FUNCTION Example(OBJECT hCursor, OBJECT hPen)
INT asLocal = 0;
REAL time;
INT milli;
STRING value;
_ObjectCallMethod(hCursor , "GetValue", hPen, asLocal, time, milli, value);
END