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

AVEVA™ Plant SCADA

IPen​.IsDeleted [Property][Get]

  • Last UpdatedJul 18, 2023
  • 1 minute read

Returns whether this pen has been marked for deletion. That is, whether someone has called the Delete method on it or deleted it from the display.

Defined As

  • [VBA] Boolean IsDeleted

  • [Cicode] INT IsDeleted

  • [C++] VARIANT_BOOL IsDeleted

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.

Calling Syntax

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

[VBA]

Sub Example(pen As Object)
Dim deleted As Boolean
deleted = pen.IsDeleted
End Sub

[Cicode]

FUNCTION Example(OBJECT hPen)
INT bDeleted;
bDeleted = _ObjectGetProperty(hPen, "IsDeleted");
END

See Also

IPen.Delete [Method]

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