Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › User Directory Methods › SearchScope Method—Sets or Retrieves LDAP Directory Search Scope

SearchScope Method—Sets or Retrieves LDAP Directory Search Scope

The SearchScope method sets or retrieves the search scope for an LDAP user directory. The search scope specifies how many levels SiteMinder searches for users or user groups in the LDAP directory.

Syntax

The SearchScope method has the following format:

Netegrity::PolicyMgtUserDir‑>SearchScope([searchScope])

Parameters

The SearchScope method accepts the following parameter:

searchScope (int)

(Optional) Specifies a new search scope for an LDAP user directory:

• USERDIR_SCOPE_SUBTREE

  Specifies searching the root and all levels below.

• USERDIR_SCOPE_ONELEVEL

  Specifies searching the root and one level below.

Return Value

The SearchScope method returns one of the following new or existing values:

• USERDIR_SCOPE_SUBTREE

  Specifies searching the root and all levels below.

• USERDIR_SCOPE_ONELEVEL

  Specifies searching the root and one level below.

• value = -1

  Specifies that the call is unsuccessful.