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

AVEVA™ Plant SCADA

ICommand​.ButtonType [Property][Get]

  • Last UpdatedJul 18, 2023
  • 1 minute read

Gets this commands button type.

Defined As

  • [VBA] Long ButtonType

  • [Cicode] INT ButtonType

  • [C++] ToolbarButtonType ButtonType

Execution Results

If the property get succeeds, the return value will be Success. If the return value is invalid, the return value will be InvalidArgument. If the command has been deleted, the return value will be GeneralFailure.

Remarks

The return value meaning is as follows:

  • ToolbarButtonType_Push = 0

  • ToolbarButtonType_Toggle = 1

  • ToolbarButtonType_Separator = 2

Calling Syntax

This example assumes there is a valid Command object as retrieved from a Process Analyst's CommandSystem. (for example, VBA: ProcessAnalyst.CommandSystem.Item(1))

[VBA]

Sub Example(Command As Object)
Dim buttonType As Long
`Getting Property value
buttonType = Command.ButtonType
End Sub

[Cicode]

FUNCTION Example(OBJECT hCommand)
// Getting property value
INT nButtonType = _ObjectGetProperty(hCommand, "ButtonType");
END

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