AlarmCatGetFormat

Returns the display format string of the specified alarm category.

Syntax

STRING AlarmCatGetFormat(INT Category [, INT Type] )

Category:

The alarm category.

Type:

The type of display format string:

0 - Alarm format. Default value.

1 - Summary format.

2 - SOE format

Return Value

The display format string of the specified category. If the alarm category is not specifically defined or it has no format string specified in your project, the format string of category 0 will be returned.

Example

sFormat = AlarmCatGetFormat(0, 0);
! sFormat is assigned to the format string as defined in the Alarm Format field of the Alarm Categories form for category 0 in your project.

See Also

Alarm Functions