IP*Works! SSH V9 - Online Help
IP*Works! SSH V9
Questions / Feedback?

GetPropertyValue Method

Looks up a property by name and returns the value.

Syntax

psclient.getPropertyValue(name, [callback])

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 this 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.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Looks up a property in the current output object by name and returns the value of said property, or an empty string if it's not found or it's null.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 9.0.6240.0