Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › User Directory Methods › SearchRoot Method—Sets or Retrieves Directory Search Root

SearchRoot Method—Sets or Retrieves Directory Search Root

The SearchRoot method sets or retrieves different values for different directory types:

• LDAP Directories

  The SearchRoot method sets or retrieves the location in the LDAP tree that is the starting point for the directory connection, for example, the organization (o) or organizational unit (ou). This location, called the search root, is the point where the Policy Server starts the search for a user.

• Custom Directories

  The SearchRoot method sets or retrieves a string of parameters to pass to the custom library.

Syntax

The SearchRoot method has the following format:

Netegrity::PolicyMgtUserDir‑>SearchRoot([srchRoot])

Parameters

The SearchRoot method accepts the following parameter:

srchRoot (string)

Specifies a new search root for an LDAP directory or parameter string for a custom directory.

Return Value

The SearchRoot method returns one of the following values:

• search_root (string)

  Specifies the new or existing search root for an LDAP directory or parameter string for a custom directory.

• undef

  Specifies that the call is unsuccessful.