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

AVEVA™ Plant SCADA

IAlarmPen​.LineWidth [Property][Get/Set]

  • Last UpdatedJul 18, 2023
  • 1 minute read

Gets or sets the width in pixels of the pen line when it is drawn.

Defined As

  • [VBA] Long LineWidth

  • [Cicode] INT LineWidth

  • [C++] int LineWidth

Execution Result

If the property get/set succeeds the return value will be Success. If the return variable is bad then the return value will be InvalidArgument. If the pen is deleted the return value will be GeneralFailure.

Limits

  • Minimum = 0

  • Maximum = 8

Calling Syntax

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

[VBA]

Sub Example(alarmPen As Object)
.....Dim lineWidth As Long
.....`Getting Property value
.....lineWidth = alarmPen.LineWidth
.....`Setting Property value
.....alarmPen.LineWidth = 5
End Sub

[Cicode]

FUNCTION Example(OBJECT hAlarmPen)
.....// Getting property value
.....INT nLineWidth = _ObjectGetProperty(hAlarmPen, "LineWidth");
.....// Setting property value
....._ObjectSetProperty(hAlarmPen, "LineWidth", 5);
END

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