AlarmFilterEditFirst | Alarm Filter Functions

Cicode Programming Reference > Cicode Function Categories > Alarm Filter Functions > AlarmFilterEditFirst

AlarmFilterEditFirst

This function takes a session handle parameter. It gets the first part of the filter. Each part is either:

A filter expression delimited with ";"
A partial filter expression truncated at 254 character (if no ";" found before)

Syntax

STRING AlarmFilterEditFirst(INT hSession)

Session

Session handle for the historical list previously returned by the function AlarmFilterEditOpen().

Return Value

First part of filter or if does not exist an empty string "".

Example

iHndl = AlarmFilterEditOpen(iAN);
iRet = AlarmFilterEditSet(iHndl,"Tag=Dig*;Category=1;Area=1;");
iRet = AlarmFilterEditAppend(iHndl, "Priority<20");
sRet = AlarmFilterEditFirst(iHndl);	// Tag=Dig*;
sRet = AlarmFilterEditNext(iHndl);	// Category=1;
sRet = AlarmFilterEditLast(iHndl);	// Priority<20;
sRet = AlarmFilterEditPrev(iHndl);	// Area=1;
iRet = AlarmFilterEditClose(iHndl);

Related Functions

AlarmFilterEditNext, AlarmFilterEditPrev