User Guide

Standard NetLinx API (SNAPI) R 1.8.0

Listener

Name: Phonebook Listener

Interface: IPhonebookComponentListener

IPhonebookComponentListener

Listener Functions:

Name: Channel: Level: Command: Constant: Notes:

processCloseEvent PHONEBOOKCLOSESEARCH-

<key>

The search associated with search key <key> have been closed. No more operations

can be performed against this search.

processDeleteRecordE-

vent

PHONEBOOKDELETE-<id>,<suc-

cess>

Phonebook record with index/id of <id> was deleted if <success> is 1, otherwise delete

failed.

processEndOfSetEvent PHONEBOOKEND-<key> End of search set was reached for search with search key <key>

processQueryDBEvent PHONEBOOKRECORD-

Phonebook record for search with search key <key>. <id> is the record ID, <#> is the

record position from 1 to the total number of records, <name> is the name/label and

<number> is the phone number.

processSearchDBEvent PHONEBOOKSEARCHRESULT-

Phonebook search results are available for search with search key <key>. <count> is

the total count of records. Use PHONEBOOKNEXT and PHONEBOOKPREV to get

more records.

processStartOfSetEvent PHONEBOOKSTART-<key> Beginning of search set was reached for search with search key <key>

processUpdateRecordE-

vent

PHONEBOOKUPDATE-<id>,<suc-

cess>

Phonebook record with index/id of <id> was updated if <success> is 1, otherwise

update failed.