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

AVEVA™ Plant SCADA

IObjectViewColumns​.Remove [Method]

  • Last UpdatedJul 18, 2023
  • 1 minute read

Removes the specified custom column from the Object View columns.

Defined As

  • [VBA] Remove(columnName As String)

  • [Cicode] OBJECT Remove(STRING columnName)

  • [C++] Remove(STRING columnName)

Parameters

columnName

[in] Indicates the unique name of the column to remove from this collection.

Execution Results

If the method succeeds, the return value will be Success. If the column cannot be found, the return value will be InvalidArgument.

Remarks

Only user created custom columns can be removed.

Calling Syntax

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

[VBA]

Sub Example(columns As Object)
Dim column As Object
`Getting Property value
Set column = columns.Remove("MyCustomColumn"
End Sub

[Cicode]

FUNCTION Example(OBJECT hColumns)
// Getting property value
OBJECT hColumn = _ObjectCallMethod(hColumns, "get_ItemByName",
"MyCustomColumn");
END

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