[TabAlarm​.Custom]Function​.AlarmGetDsp

Sets your own function to return the value of the specified alarm field on the tab style alarm templates. If specified, your function, instead of the default one, will be called to return the value for the requested alarm field.

Note: This parameter is available only to projects based on the Tab_Style templates.

Allowable Values:

Name of user defined function which conforms to the following specification:

Syntax

<function>(INT listID, INT recordAN, STRING field)

• listID: ID of the alarm list

• recordAN: Animation Number (AN) of the alarm record

• field: Name of the alarm field being requested

Default Value:

None

Return Value:

Value of the alarm field

Example

[TabAlarm.Custom]

Function.AlarmGetDsp = MyAlarmValue

STRING FUNCTION MyAlarmValue(INT listID, INT recordAN, STRING field)

// return a textual description for priority

IF (field = "Priority") THEN

SELECT CASE AlarmGetDsp(recordAN, field)

CASE "1"

RETURN "Critical";

CASE "2"

RETURN "Major";

CASE ELSE

RETURN "Minor";

END SELECT

ELSE

RETURN AlarmGetDsp(recordAN, field);

END

END

See Also

[TabAlarm.Custom] Parameters