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

AVEVA™ Plant SCADA

IAlarmPen​.GetFillColor [Method]

  • Last UpdatedJul 18, 2023
  • 1 minute read

Gets the color used to fill the pen for the specified state.

Defined As

  • [VBA] GetFillColor(state as Long) as Long

  • [Cicode] INT GetFillColor(INT state)

  • [C++] HRESULT GetFillColor(int state, OLE_COLOR* color)

Execution Result

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

Parameters

state

[in] The state for which fill color to retrieve (0 to 8).

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)
.....Dim fillColor As Long
.....fillColor = alarmPen.GetFillColor(0)
End Sub

[Cicode]

FUNCTION Example(OBJECT hAlarmPen)
.....INT nFillColor = _ObjectCallMethod(hAlarmPen, "GetFillColor" , 0);
END

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