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

AVEVA™ Plant SCADA

IPen​.SetQualityLineStyle [Method]

  • Last UpdatedJul 18, 2023
  • 1 minute read

This function can be used to change the type of line drawn for each of the quality states defined by the Process Analyst for this Pen only.

Defined As

  • [VBA] SetQualityLineStyle(qualityType As Integer, lineStyle As Integer)

  • [Cicode] SetQualityLineStyle(INT qualityType, INT lineStyle)

  • [C++] HRESULT SetQualityLineStyle(QualityType qualityType, LineStyle lineStyle)

Parameters

qualityType

[in] Indicates which quality type you want to set the visual cue for.

lineStyle

[in] Indicates which line style visual cue to use for the selected quality type.

Execution Result

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

Remarks

When a sample is added to the display, its quality value indicates how the line drawn from that sample to the next one will be displayed.

Calling Syntax

Assumes you have passed a valid pen object into the function.

[VBA]

Sub Example(pen As Object)
` Set lines drawn after NA samples to be drawn as dash_dot
pen.SetQualityLineStyle 1, 3
End Sub

[Cicode]

FUNCTION Example(OBJECT hPen)
// Set lines drawn after NA samples to be drawn as dash_dot
_ObjectCallMethod(hPen, "SetQualityLineStyle", 1, 3);
END

See Also

QualityType [Enumeration]

LineStyle [Enumeration]

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