SearchScope Property

Controls the scope of LDAP search operations.

Syntax

 ldap.getSearchScope([callback])
 ldap.setSearchScope( searchScope, [callback])

Possible Values

  0 (ssBaseObject), 
  1 (ssSingleLevel), 
  2 (ssWholeSubtree)

Default Value

2

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 getSearchScope([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 setSearchScope([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 controls the scope of LDAP search operations. Possible values are:

Default is to search the whole subtree.

Data Type

Integer