RFID Reader Interface Reference
3.4 IRfReaderApi
Mobile Readers
68
Function Manual, 12/2010, J31069-D0198-U001-A2-7618
3.4.24
UnsubscribeForNotifications
UnsubscribeForNotifications(notificationChannel : string) : void
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.
Return value(s)
None.
Exceptions
RfReaderApiException
Error while communicating with the reader service.
Check the Error member for more information.
Note
This function stops notifications about tag events via the TagEventNotification event of the
reader interface. The given notification channel name specifies which notification to
terminate. An empty string or "ALL" unsubscribes from both the RFID and the barcode
channel available in a default RF-MANAGER project for an handheld device.
Whenever a previous subscription for a given channel name succeeded,
UnsubscribeForNotifications for the same channel name will succeed even if the underlying
connection might be temporarily unavailable.
Limitations
RF-MANAGER mode only.
Whenever channel names are used that do not exist within the configuration,
UnsubscribeForNotifications 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: ......