ITrendCursor.Name [Property][Get/Set]

Get or Set the Name of the cursor.

Defined As

• [VBA] String Name
• [Cicode] STRING Name
• [C++] BSTR Name

Execution Result

If the property get/set succeeds, the return value will be Success. If the return variable is bad, the return value will be InvalidArgument. If the name is 0 characters or greater than 250, the return value will be InvalidArgument.

If the cursor is deleted, the return value will be GeneralFailure.

Remarks

When setting the name property, remember that cursor names needs to be unique. Setting the Name property will not succeed if a cursor with that name already exists.

Calling Syntax

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

[VBA]

Sub Example(cursor As Object)

	Dim name As String

		`Getting Property value

   name = cursor.Name

		`Setting Property value

   cursor.Name = "NewCursor"

End Sub

[Cicode]

FUNCTION Example(OBJECT hCursor)

   STRING name;

	// Getting current property value

 name = _ObjectGetProperty(hCursor, "Name");

	 // Setting Property

	 _ObjectSetProperty(hCursor, "Name", "NewCursor");

END