Subscribeforalarms - Siemens SIMATIC RF310M Function Manual

3.4.20

SubscribeForAlarms

SubscribeForAlarms(alarmChannel : string,
Parameters
● alarmChannel
RfReaderApi.AC_ALL
RfReaderApi.AC_DEFAULT
● isFilter
Return value(s)
A boolean value telling whether the subscription succeeded (true) or failed (false).
Exceptions
RfReaderApiException
Note
This function registers for asynchronous notifications of RFID alarms. Users have to either
specify the name of the alarm channel (which depends on the underlying configuration) or
use an empty string or "ALL" in order to subscribe to all available alarm channels.
Notifications from the underlying reader service are delivered via the Alarms event.
Users should always subscribe for alarms both when working RF-MANAGER integrated or
standalone. The ReaderService uses the alarm channel to notify clients about the end of its
startup or restart phase by sending a "Reconfiguration" alarm. Only after receiving this alarm,
the RFID interface is fully initialized and able to support all features.
Limitations
RF-MANAGER mode only.
If there is no configuration data available or the contained alarm channels do not match in
name, calls to SubscribeForAlarms will fail.
Version information
Supported in RFID Reader Interface: since V1.1
Mobile Reader
Function Manual, 02/2009, J31069-D0198-U001-A1-0076
isFilter : bool) : bool
The name of an alarm channel that asynchronously provides alarms.
Reserved for future use. Must be false in this version of the API. A value of true leads to a
not implemented exception.
This is a shortcut for all possible alarm channels. The current
version of the API does only support the default alarm channel
This is the name of the default alarm channel available in every
configuration.
Error while communicating with the reader service.
Check the Error member for more information.
RFID Reader Interface Reference
3.4 IRfReaderApi
67