SearchDerefAliases Property

Controls alias dereferencing during searching.

Syntax

 ldap.getSearchDerefAliases([callback])
 ldap.setSearchDerefAliases( searchDerefAliases, [callback])

Possible Values

  0 (sdaNever), 
  1 (sdaInSearching), 
  2 (sdaFindingBaseObject), 
  3 (sdaAlways)

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 getSearchDerefAliases([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 setSearchDerefAliases([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 alias dereferencing during searching. Possible values are:


sdaNever (0)	Do not dereference aliases in searching or in locating the base object of the search.
sdaInSearching (1)	Dereference aliases in subordinates of the base object in searching, but not in locating the base object of the search.
sdaFindingBaseObject (2)	Dereference aliases in locating the base object of the search, but not when searching subordinates of the base object.
sdaAlways (3)	Dereference aliases both in searching and in locating the base object of the search.

Default is to never dereference aliases.

Data Type

Integer