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

AVEVA™ Plant SCADA

IPane​.Name [Property][Get/Set]

  • Last UpdatedJul 18, 2023
  • 1 minute read

Gets or Sets the name of this pane.

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 a pane of the same name exists, the return value will be InvalidArgument. If the panes collection is deleted, the return value will be GeneralFailure.

Limits

Name needs to be between 1-250 characters.

Remarks

Pane names needs to be unique.

Calling Syntax

This example assumes there is a valid Pane object to be passed into the example methods.

[VBA]

Sub Example(pane As Object)
Dim name As String
`Getting Property value
name = pane.Name
`Setting Property value
pane.Name = "Alarms"
End Sub

[Cicode]

FUNCTION Example(OBJECT hPane)
// Getting property value
STRING sName = _ObjectGetProperty(hPane, "Name");
// Setting property value
_ObjectSetProperty(hPane, "Name", "Alarms");
END

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