IAlarmPen.AlarmType [Property][Get/Set]

Gets or Sets the display type of this alarm pen.

Defined As

• [VBA] Long AlarmType
• [Cicode] INT AlarmType
• [C++] AlarmType AlarmType

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.

Remarks

This AlarmType also dictates the number of alarm states, and their descriptions.

See Also

IAlarmPen.AlarmType [Property][Get/Set]

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

	 `Getting Property value

   alarmType = alarmPen.AlarmType

	`Setting Property value to Analog

 alarmPen.AlarmType = 1

End Sub

[Cicode]

FUNCTION Example(OBJECT hAlarmPen)

 // Getting property value

 INT eAlarmType = _ObjectGetProperty(hAlarmPen, "AlarmType");

	// Setting property to Analog

	 _ObjectSetProperty(hAlarmPen, "AlarmType", 1);

END