Unsubscribefornotifications - Siemens SIMATIC RF310M Function Manual

RFID Reader Interface Reference
3.4 IRfReaderApi
3.4.24

UnsubscribeForNotifications

UnsubscribeForNotifications(notificationChannel : string) : void
Parameters
● notificationChannel
RfReaderApi.NC_RFID
RfReaderApi.NC_BARCODE
RfReaderApi.NC_ALL
Return value(s)
None.
Exceptions
RfReaderApiException
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
68
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.
This is the data source name if you want to target the RFID
component
This is the data source name if you want to target the barcode
component
This is a generic name that subscribes for all configured data
sources within a project.
Error while communicating with the reader service.
Check the Error member for more information.
Function Manual, 12/2010, J31069-D0198-U001-A2-7618
Mobile Readers