AlarmGetFilterName

Retrieves the name of the linked named filter for the supplied An. If empty text, there is currently no linked named filter.

Syntax

STRING AlarmGetFilterName(INT An)

An

Animation number

Return Value

Name of linked filter or " ".

Example

// This example shows how to link, unlink and check the linking of a
// named filter to an alarm list (by its animation number)
// This example requires that the named filter "Myfilter" exists.
STRING sName;
INT nError;
INT nAnimationNumber=21;
INT nSetInfoFilterName=12;
nError = AlarmSetInfo(nAnimationNumber, nSetInfoFilterName, "MyFilter");
IF nError = 0 THEN

sName = AlarmGetFilterName(nAnimationNumber); //"MyFilter"

END
nError = AlarmSetInfo(nAnimationNumber, nSetInfoFilterName, "");
IF nError = 0 THEN

sName = AlarmGetFilterName(nAnimationNumber); //""

END

Related Functions

AlarmFilterOpen

See Also

Alarm Filter Functions