IPen.DataPoint [Property][Get/Set]

Get or Set the trend/alarm tag which this pen is bound to.

Defined As

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

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 tag is greater than 79 characters, the return value will be InvalidArgument. If the pen is deleted, the return value will be GeneralFailure.

Remarks

This property works in conjunction with the DataServer property. This property can be changed during the lifetime of the pen. Changing the DataPoint property will result in the data cache being cleared and a new data request issued. A request for the tag's information will also be issued.

See Also

IPen.DataServer [Property][Get/Set]

Calling Syntax

Assumes you have passed a valid pen object into the function.

[VBA]

Sub Example(pen As Object)

 Dim tag As String

 `Getting Property value

   tag = pen.DataPoint

	 `Setting Property value

   pen.DataPoint = "LOOP_1_PV"

End Sub

[Cicode]

FUNCTION Example(OBJECT hPen)

	STRING tag;

	 // Getting current property value

 tag = _ObjectGetProperty(hPen, "DataPoint");

	// Setting Property 

	_ObjectSetProperty(hPen, "DataPoint", "LOOP_1_PV");

END