IAlarmPen.GetHatchStyle [Method]

Gets the hatch style used when drawing the boxes for the specified state.

Defined As

• [VBA] GetHatchStyle(state as Long) as Long
• [Cicode] INT GetHatchStyle(INT state)
• [C++] HRESULT GetHatchStyle(int state, HatchStyle* color)

Parameters

state

[in] The state for which you would like to retrieve a hatch style (0 to 8).

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.

See Also

IAlarmPen.GetHatchStyle [Method]

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 hatchStyle As Long

	hatchStyle = alarmPen.GetHatchStyle(0)

End Sub

[Cicode]

FUNCTION Example(OBJECT hAlarmPen)

 INT nHatchStyle = _ObjectCallMethod(hAlarmPen, "GetHatchStyle", 0);

END