AN , Alarm Number , ALMCB Alarm record

AN stands for Animation Number. It is a unique numeric identifier for graphic objects on a page.

AlarmGetDsp() is intended for use on graphics pages that contain one or more alarm lists.
Alarm lists normally consist of a series of AN (or cicode) objects aligned vertically on a page. The numbering should be sequential.

If you want to use alarm properties in cicode scripts (not on graphics pages) then take a look at:
- AlmBrowseGetField() for use while browsing through alarm recordsets.
- AlarmGetFieldRec() when you know the alarm record number (from the alarm event queue for example).

Hope this helps.

Hello Patrick thank you for your answer , it really clarifies a lot of things , 

other than that , i was trying to use the AlarmGetDsp to get some specified fields in the alarm SOE , and then insert them onto an excel , but you said that this function is only for use on graphics pages that contains one or more alarm lists 

you suggested using AlmBrowseGetField() and i believe in order to use this function i must know the handle to a browse session that i should retrieve from the function AlmBrowseOpen , so it is as if i am creating a new alarm browsing session ? 

Thank you 

Hello Patrick thank you for your answer , it really clarifies a lot of things , 

other than that , i was trying to use the AlarmGetDsp to get some specified fields in the alarm SOE , and then insert them onto an excel , but you said that this function is only for use on graphics pages that contains one or more alarm lists 

you suggested using AlmBrowseGetField() and i believe in order to use this function i must know the handle to a browse session that i should retrieve from the function AlmBrowseOpen , so it is as if i am creating a new alarm browsing session ? 

Thank you 

Yes, in order to use that function you should create (open) a browse session. You can find examples of its use in the product Help and in the Example project (PA_Equip.ci for example).

Please take note however, that AlmBrowse functions act on ALL configured alarms, not only the current active or historical ones.

In order to browse through your SOE alarms you could use AlarmFirstCatRec(iCat, iType)
where iCat is the required category (0 for all categories) and iType is 15 or 16 for SOE alarms.

edit: you can subsequently use AlarmGetFieldRec() to retrieve alarm information on each record.

See Help for more information and an example.

Thank you Patrick for you valuable time , the note u said about what this function acts on is interesting ,

is there a function that acts directly on the active alarms , or a function where i will chose which alarm to act on ? 

maybe i can do so by using the filter in the AlmBrowseOpen  , and chose the alarms u want to act on 

Nice , i see your point. i am so greatful