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

AVEVA™ Plant SCADA

IAlarmPen​.SetHatchStyle [Method]

  • Last UpdatedJul 18, 2023
  • 1 minute read

Sets the hatch style used for drawing the specified state.

Defined As

  • [VBA] SetHatchStyle(state as Long, HatchStyle as Long)

  • [Cicode] INT SetHatchStyle (INT state, INT hatchStyle)

  • [C++] HRESULT SetHatchStyle (int state, HatchStyle hatchStyle)

Parameters

state

[in] The state for which you would like to assign a hatch style.

hatchStyle

[in] The hatch style that will be used for the specified state.

Execution Result

If the function succeeds the return value will be Success. If the state is out of range then the return value will be InvalidArgument. If the pen is deleted the return value will be GeneralFailure.

Remarks

The color value can be calculated using the following formula: color = (65536 * Blue) + (256 * Green) + (Red). Where red, green and blue are 0-255.

Calling Syntax

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

[VBA]

Sub Example(alarmPen As Object)
.....`Setting HatchStyle
.....alarmPen.SetHatchStyle(0, 1)
End Sub

[Cicode]

FUNCTION Example(OBJECT hAlarmPen)
.....// Setting HatchStyle
....._ObjectCallMethod(hAlarmPen, "SetHatchStyle" ,0, 1);
END

See Also

IAlarmPen.GetHatchStyle [Method]

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