Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Plant SCADA

ICursors​.Item [Property][Get]

  • Last UpdatedJul 18, 2023
  • 1 minute read

Retrieves the Cursor from the collection at the specified index.

Defined As

  • [VBA] Object Item(index As Integer)

  • [Cicode] OBJECT get_Item(INT index)

  • [C++] HRESULT get_Item (long index, ITrendCursor **cursor)

Parameters

index

[in] The index of the necessary cursor.

Execution Result

If the property get succeeds, the return value will be Success. If the return variable is bad, the return value will be InvalidArgument.

If the index is out of range, the return value will be InvalidArgument. If the collection is deleted, the return value will be GeneralFailure.

Remarks

The index for the collection is 1 based. The valid range for this parameter is between 1 and the total number of cursors.

Calling Syntax

This example assumes you have a valid reference to the cursors collection and that there are two items in the collection.

[VBA]

Sub Example(hCursors As Object)
Dim hSecondCursor As Object
Set hSecondCursor = hCursors.Item(2)
End Sub

[Cicode]

Sub Example(OBJECT hCursors)
OBJECT hSecondCursor = _ObjectCallMethod(hCursors, "get_Item", 2);
END

In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in