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

Search

The following parameters allow you to access search parameters through the parameter block.

Table 18–28 Search Function Parameters

Parameter ID  

Data Type  

Description  

SLAPI_NENTRIES

int

Number of entries returned by the search. 

SLAPI_SEARCH_ATTRS

char **

Array of attribute types to return in the search results. 

The asterisk, *, can be used to mean all real (non-virtual) attributes.

SLAPI_SEARCH_ATTRSONLY

int

Whether to return both attribute types and attribute values. 

  • 0 return both.

  • 1 return only types.

SLAPI_SEARCH_DEREF

int

Method for handling aliases. 

  • LDAP_DEREF_ALWAYS

  • LDAP_DEREF_FINDING

  • LDAP_DEREF_NEVER

  • LDAP_DEREF_SEARCHING

SLAPI_SEARCH_FILTER

Slapi_Filter *

Filter to be used for the search. 

SLAPI_SEARCH_REFERRALS

struct berval **

Array of URLs to other LDAP servers to which the client is referred. 

SLAPI_SEARCH_RESULT_ENTRY

void *

Entry returned while iterating through the result set. 

You may cast this to Slapi_Entry.

SLAPI_SEARCH_SCOPE

int

Scope of the search. 

  • LDAP_SCOPE_BASE

  • LDAP_SCOPE_ONELEVEL

  • LDAP_SCOPE_SUBTREE

SLAPI_SEARCH_SIZELIMIT

int

Maximum number of entries to return in the search results. 

SLAPI_SEARCH_STRFILTER

char *

String representation of the filter to be used for the search. 

SLAPI_SEARCH_TARGET

char *

DN of base entry for the search. 

SLAPI_SEARCH_TIMELIMIT

int

Maximum number of seconds to allow for the search.