Novell.Directory.Ldap.LdapSearchResults.Abandon C# (CSharp) Method

Abandon() private method

Cancels the search request and clears the message and enumeration.
private Abandon ( ) : void
return void
        internal virtual void Abandon()
        {
            // first, remove message ID and timer and any responses in the queue
            queue.MessageAgent.AbandonAll();

            // next, clear out enumeration
            resetVectors();
            completed = true;
        }

Usage Example

Example #1
0
		/// <summary> 
		/// 
		/// Notifies the server not to send additional results associated with
		/// this LdapSearchResults object, and discards any results already
		/// received.
		/// 
		/// </summary>
		/// <param name="results">  An object returned from a search.
		/// 
		/// </param>
		/// <param name="cons">    The contraints specific to the operation.
		/// 
		/// </param>
		/// <exception> LdapException A general exception which includes an error
		/// message and an Ldap error code.
		/// </exception>
		public virtual void  Abandon(LdapSearchResults results, LdapConstraints cons)
		{
			results.Abandon();
			return ;
		}