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

AVEVA™ Plant SCADA

ICommandSystem​.Execute [Method]

  • Last UpdatedJul 18, 2023
  • 1 minute read

Executes the specified command's action.

Defined As

  • [VBA] Execute (commandId As String)

  • [Cicode] Execute (STRING commandId)

  • [C++] HRESULT Execute(BSTR commandId)

Parameters

commandId

[in] The unique ID of the command whose action is to be executed.

Execution Result

If this method succeeds, the return value will be Success. If the command is invalid, the return value will be InvalidArgument.

Remarks

If the current Operator does not have the correct privilege, the command will not execute.

Calling Syntax

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

[VBA]

Sub Example(CommandSystem As Object)
CommandSystem.Execute("Citect_Command_AddPen")
End Sub

[Cicode]

FUNCTION Example(OBJECT hCommandSystem)
_ObjectCallMethod(hCommandSystem, "Execute", "Citect_Command_AddPen");
END

See Also

ICommand Interface

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