Phonebook Property

This property reads the PhonebookEntry when dialing the remote machine.

Syntax

 netdial.getPhonebook([callback])
 netdial.setPhonebook( phonebook, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getPhonebook([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setPhonebook([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property reads the PhonebookEntry when dialing the remote machine. This property is valuable only in Windows NT 4.0 and higher where multiple phonebooks can be specified. The PhonebookEntry is relative to Phonebook. If it is empty the default phonebook is used.

Data Type

String