ICommand.Privilege [Property][Get]

Gets the privilege necessary to gain access to this command.

Defined As

• [VBA] Integer Privilege
• [Cicode] INT Privilege
• [C++] int Privilege

Execution Result

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

Remarks

This is the necessary privilege level of the currently logged in CitectSCADA user to enable the state of this command, and hence allow access through the user interface. If the currently logged in CitectSCADA user doesn't have this privilege, any buttons tied to this command will be disabled.

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 privilege As Integer

  `Getting Property value

   privilege = Command.Privilege

End Sub

[Cicode]

FUNCTION Example(OBJECT hCommand)

  // Getting property value

 INT Privilege = _ObjectGetProperty(hCommand, "Privilege");

END