Technical information

RMS NetLinx Virtual Device API
155
RMS Enterprise - NetLinx Programmer’s Guide
RMS Hotlist - Command API
RMS Hotlist Event Notification Commands
RMS Hotlist Query Commands
RMS Hotlist Event Notification Commands
String Description
HOTLIST.COUNT-
<is-client-default-location>,
<location-id>,
<record-count-number>
This event notification command will be sent when the RMS client detects a change in the number
of hotlist records available for the default client location.
RMS Hotlist Query Commands
Query Command Description / Response Command
?HOTLIST.COUNT-
(<location-id>)
This command will query the RMS client to determine the number of active hotlist records
for this location already known by the client.
The following command response will be returned from this query:
HOTLIST.COUNT-<location-id>,
<record-count-number>
This command query does not perform a query against the RMS server, but rather returns
the number of hotlist records last known by the RMS client. The RMS client and server
communicate the hotlist count on a regular basis.
The <location-id> argument is optional. If included the hotlist query will perform a lookup on
the specified location. If omitted, the hotlist query will perform a lookup on the client gate-
way's default location.
?HOTLIST.RECORDS-
(<location-id>)
This command will query the RMS server and retrieve hotlist items for this location. This
command will perform a query directly to the RMS server and when the records have been
delivered the following count response command will be returned by the RMS client.
HOTLIST.RECORD.COUNT-<location-id>,
<number-of-total-records>
The queried hotlist records are cached in the RMS client and the following
HOTLIST.RECORD query commands can be used to interrogate the cached data records.
The <location-id> argument is optional. If included the hotlist query will perform a lookup on
the specified location. If omitted, the hotlist query will perform a lookup on the client gate-
way's default location.