User Guide

95
Standard NetLinx API (SNAPI) R 1.8.0
Phonebook
Component
Name: Phonebook
Interface: IPhonebookComponent
IPhonebookComponent
Component Functions:
Name: Channel: Level: Command: Constant: Notes:
closeSearchDB(search-
Handle)
PHONEBOOKCLOSESEARCH-
<key>
Close the search associated with search key = <key>
deleteRecord(recordID) PHONEBOOKDELETE-<id> Delete phonebook record with index/id of <id>
getPhonebookCapacity() ?PHONEBOOKCAPACITY Query for the phonebook capacity. Responds with PHONEBOOKCAPACITY-<count>
where count is 1 to x and x is the maximum supported phonebook index (see specific
module documentation)
queryDB(si) PHONEBOOKNEXT-
<key>[,<count>,<position>]
Request next <count> records starting with record <position> for the phonebook search
associated with search key <key>. If <count> is not present, it is assumed to be 1. If
<position> is not present, it is assumed th be the next record in the search result set
based on the last PHONEBOOKNEXT or PHONEBOOKPREV command. Responses
with PHONEBOOKNEXT-<key>,<count>,<position> where <key> is the search key,
<count> is the number of records to expect and <position> is the position of the first
record to be returned between 1 through the total number of records.
queryDB(si) PHONEBOOKPREV-
<key>[,<count>]
Request previous <count> records for the phonebook search associated with search
key <key>. If <count> is not present, it is assumed to be 1. Responses with PHONE-
BOOKPREV-<key>,<count>,<position> where <key> is the search key, <count> is the
number of records to expect and <position> is the position of the first record to be
returned between 1 through the total number of records.
queryDB(si) PHONEBOOKREFRESH-
<key>[,<count>]
Refresh <count> records starting with the last starting position used with a PHONE-
BOOKNEXT or PHONEBOOKPREV command for the phonebook search associated
with search key <key>. If <count> is not present, it is assumed to be 1. Responses
with PHONEBOOKNEXT-<key>,<count>,<position> where <key> is the search key,
<count> is the number of records to expect and <position> is the position of the first
record to be returned between 1 through the total number of records.
searchDB(sr) PHONEBOOKSEARCH-
<key>,ID=<id>
Search the phonebook database for records with ID equal to <id>. If <id> is "*", all
records are returned. <key> is a search key used in other search operations, such as
closeSearchDB(). It can be any string you like, such as a panel device number or inter-
nal key that makes sense for your program. All future DB operation associated with this
search will reference this key value.
updateRecord(sdr) PHONEBOOKUPDATE-
<id>,<name>,<number>
Update phonebook record with index/id of <id>, where <name> is the new name and
<number> is the new number