Sun Java System Directory Server Enterprise Edition 6.2 Developer's Guide

roles_get_scope_fn_type

Specifies a callback function to determine the role of a scope. The plug-in triggers this callback using slapi_role_get_scope().

Syntax

#include "slapi-plugin.h"
typedef int (*roles_get_scope_fn_type)(Slapi_Entry *role_entry,
    Slapi_DN ***scope, int *nb_scope);

Parameters

The callback takes the following parameters.

Table 15–10 roles_get_scope_fn_type Parameters

Parameter 

Description 

role_entry

Entry defining the role 

scope

Set this to the Distinguished Name of the entry at the base of the scope 

nb_scope

Set this to a value such as LDAP_SCOPE_BASE, LDAP_SCOPE_ONELEVEL , or LDAP_SCOPE_SUBTREE

Description

This callback determines the role of a scope identified by role_entry. Register the callback with the server using slapi_register_role_get_scope() .

Returns

The callback returns 0 if successful, -1 otherwise.