RFID Reader Interface Reference
3.4 IRfReaderApi
Mobile Readers
Function Manual, 12/2010, J31069-D0198-U001-A2-7618
67
3.4.23
SubscribeForNotifications
SubscribeForNotifications(notificationChannel : string,
isFilter : bool) : bool
Parameters
● notificationChannel
The name of a notification channel that provides tag event data whereas a notification
channel is – from the API’s perspective – the source of tag events.
The following table contains the constants for default notification channel names that are
available.
RfReaderApi.NC_RFID
This is the data source name if you want to target the RFID
component
RfReaderApi.NC_BARCODE
This is the data source name if you want to target the barcode
component
RfReaderApi.NC_ALL
This is a generic name that subscribes for all configured data
sources within a project.
● isFilter
Determine whether a subscriber is merely monitoring data (i.e. isFilter is false) or
intercepts data before it is passed on to other clients.
Return value(s)
A boolean value telling whether the subscription succeeded (true) or failed (false).
Exceptions
RfReaderApiException Error while communicating with the reader service.
Check the Error member for more information.
Note
This function registers for asynchronous notifications of tag events. Users have to either
specify the name of the notification channel that creates tag events (which depends on the
underlying configuration) or use an empty string or "ALL" in order to subscribe to both the
RFID and the barcode notification channel that are available in a default RF-MANAGER
project for an handheld device.
Notifications from the underlying reader service are delivered via the TagEventNotifications
event.
Limitations
RF-MANAGER mode only.
If there is no configuration data available or the contained notification channels do not match
in name, calls to SubscribeForNotifications will fail.
Version information
Supported in RFID Reader Interface: since V1.1
Summary of Contents for SIMATIC RF610M
Page 2: ......
Page 8: ...Introduction Mobile Readers 8 Function Manual 12 2010 J31069 D0198 U001 A2 7618 ...
Page 79: ......