Get property of advanced alarm tag

You don't want to call AlmBrowseOpen from a display expression on a graphics page because it may take some time to look up the information on the alarm server. Here's a sample Cicode function that you can call from the On Page Entry event for the page so it will look up the value as soon as you open the page. Then, it writes the result into a page string (temporary storage) so you can display it easily.

//Looks up an alarm property and writes it to a page string named <alarmtag>.<alarmfield>
//Read the value back with PageGetStr()
FUNCTION AlmPropToPg(STRING sAlarmTag, STRING sAlarmField)
	INT hAlarms;
	STRING sValue;

	hAlarms = AlmBrowseOpen(sAlarmTag, sAlarmField);

	IF hAlarms <> -1 THEN
		AlmBrowseFirst(hAlarms);
		sValue = AlmBrowseGetField(hAlarms, sAlarmField);
		PageSetStr(sAlarmTag + "." + sAlarmField, sValue);
	ELSE
		TraceMsg("AlmPropToPg() Failed to open alarm browse session");
	END
END

Here's the command you'd put in the page event command to look up the comment for Loop_4_SP (an alarm tag in the Example project). You can also see the string expression I put on the page to display the value using the PageGetStr() command.

You don't want to call AlmBrowseOpen from a display expression on a graphics page because it may take some time to look up the information on the alarm server. Here's a sample Cicode function that you can call from the On Page Entry event for the page so it will look up the value as soon as you open the page. Then, it writes the result into a page string (temporary storage) so you can display it easily.

//Looks up an alarm property and writes it to a page string named <alarmtag>.<alarmfield>
//Read the value back with PageGetStr()
FUNCTION AlmPropToPg(STRING sAlarmTag, STRING sAlarmField)
	INT hAlarms;
	STRING sValue;

	hAlarms = AlmBrowseOpen(sAlarmTag, sAlarmField);

	IF hAlarms <> -1 THEN
		AlmBrowseFirst(hAlarms);
		sValue = AlmBrowseGetField(hAlarms, sAlarmField);
		PageSetStr(sAlarmTag + "." + sAlarmField, sValue);
	ELSE
		TraceMsg("AlmPropToPg() Failed to open alarm browse session");
	END
END

Here's the command you'd put in the page event command to look up the comment for Loop_4_SP (an alarm tag in the Example project). You can also see the string expression I put on the page to display the value using the PageGetStr() command.