C# Class Novell.Directory.Ldap.LdapSearchConstraints

Defines the options controlling search operations. An LdapSearchConstraints object is always associated with an LdapConnection object; its values can be changed with the LdapConnection.setConstraints method, or overridden by passing an LdapSearchConstraints object to the search operation.
Inheritance: LdapConstraints
显示文件 Open project: EventStore/csharp-ldap Class Usage Examples

Public Methods

Method Description
LdapSearchConstraints ( LdapConstraints cons ) : System

Constructs an LdapSearchConstraints object initialized with values from an existing constraints object (LdapConstraints or LdapSearchConstraints).

LdapSearchConstraints ( int msLimit, int serverTimeLimit, int dereference, int maxResults, bool doReferrals, int batchSize, LdapReferralHandler handler, int hop_limit ) : System

Constructs a new LdapSearchConstraints object and allows the specification operational constraints in that object.

Private Methods

Method Description
InitBlock ( ) : void
LdapSearchConstraints ( ) : System

Method Details

LdapSearchConstraints() public method

Constructs an LdapSearchConstraints object initialized with values from an existing constraints object (LdapConstraints or LdapSearchConstraints).
public LdapSearchConstraints ( LdapConstraints cons ) : System
cons LdapConstraints
return System

LdapSearchConstraints() public method

Constructs a new LdapSearchConstraints object and allows the specification operational constraints in that object.
public LdapSearchConstraints ( int msLimit, int serverTimeLimit, int dereference, int maxResults, bool doReferrals, int batchSize, LdapReferralHandler handler, int hop_limit ) : System
msLimit int The maximum time in milliseconds to wait for results. /// The default is 0, which means that there is no /// maximum time limit. This limit is enforced for an /// operation by the API, not by the server. /// The operation will be abandoned and terminated by the /// API with an LdapException.Ldap_TIMEOUT if the /// operation exceeds the time limit. /// ///
serverTimeLimit int The maximum time in seconds that the server /// should spend returning search results. This is a /// server-enforced limit. The default of 0 means /// no time limit. /// The operation will be terminated by the server with an /// LdapException.TIME_LIMIT_EXCEEDED if the search /// operation exceeds the time limit. /// ///
dereference int Specifies when aliases should be dereferenced. /// Must be either DEREF_NEVER, DEREF_FINDING, /// DEREF_SEARCHING, or DEREF_ALWAYS from this class. /// Default: DEREF_NEVER /// ///
maxResults int The maximum number of search results to return /// for a search request. /// The search operation will be terminated by the server /// with an LdapException.SIZE_LIMIT_EXCEEDED if the /// number of results exceed the maximum. /// Default: 1000 /// ///
doReferrals bool Determines whether to automatically follow /// referrals or not. Specify true to follow /// referrals automatically, and false to throw /// an LdapException.REFERRAL if the server responds /// with a referral. /// It is ignored for asynchronous operations. /// Default: false /// ///
batchSize int The number of results to return in a batch. Specifying /// 0 means to block until all results are received. /// Specifying 1 means to return results one result at a /// time. Default: 1 /// /// ///
handler LdapReferralHandler The custom authentication handler called when /// LdapConnection needs to authenticate, typically on /// following a referral. A null may be specified to /// indicate default authentication processing, i.e. /// referrals are followed with anonymous authentication. /// ThE object may be an implemention of either the /// the LdapBindHandler or LdapAuthHandler interface. /// It is ignored for asynchronous operations. /// ///
hop_limit int The maximum number of referrals to follow in a /// sequence during automatic referral following. /// The default value is 10. A value of 0 means no limit. /// It is ignored for asynchronous operations. /// The operation will be abandoned and terminated by the /// API with an LdapException.REFERRAL_LIMIT_EXCEEDED if the /// number of referrals in a sequence exceeds the limit. /// ///
return System