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

AVEVA™ Plant SCADA

IPen​.Delete [Method]

  • Last UpdatedJul 18, 2023
  • 1 minute read

Deletes the pen from the Process Analyst.

Defined As

  • [VBA] Delete()

  • [Cicode] Delete()

  • [C++] HRESULT Delete()

Execution Result

If the function succeeds, the return value will be Success. If the pen is already deleted, the return value will be GeneralFailure.

Remarks

Calling this method will mark the pen for deletion, meaning any further calls to methods or properties on the pen will result in a GeneralFailure error. The pen will be removed from the display immediately after making this call.

Calling Syntax

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

[VBA]

Sub Example(pen As Object)
pen.Delete
End Sub

[Cicode]

FUNCTION Example(OBJECT hPen)
_ObjectCallMethod(hPen, "Delete");
END

See Also

IPen.IsDeleted [Property][Get]

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