Interface ADsSearchResult

public interface ADsSearchResult
{
  // Methods
  public void CloseSearchHandle() throws IADsException;
  public ADsSearchColumn GetColumn(String Column)
        throws IADsException;
  public void GetFirstRow() throws IADsException;
  public String GetNextColumnName() throws IADsException;
  public void GetNextRow() throws IADsException;
}

This interface specifies ADsSearchResult.

Also see Also Active Directory Design Specification Version 2.0

Methods

CloseSearchHandle 

public void CloseSearchHandle() throws IADsException;

Closes the search handle returned by a previous call to ExecuteSearch.

Exceptions

IADsException failed to perform operation

GetColumn 

public ADsSearchColumn GetColumn(String Column)
        throws IADsException;

This method returns the column denoted by ColumnName for the current row. A new SearchColumn will be allocated and returned. This has to be freed using the function FreeColumn.

Return Value

Returns search column

Parameter	Description
Column	search column name

Exceptions

IADsException failed to perform operation

GetFirstRow 

public void GetFirstRow() throws IADsException;

This method returns the first entry assocaited with the ADsSearchResult. The underlying object is manipulated such that users can always get the first row of a search result by calling this method. Note that it is not necessary to use this method, GetNextRow will automatically return the first row, if that is appropriate row to return.

Exceptions

IADsException, throw if the opearation fails.

GetNextColumnName 

public String GetNextColumnName() throws IADsException;

Returns the name of the next column to found in the current row. The main use of thismethod is when the user has called ExecuteSearch asking for all the attributes and thus does not know which attributes to get using GetColumn.

Return Value

Returns column name

Exceptions

IADsException failed to perform operation

GetNextRow 

public void GetNextRow() throws IADsException;

This method advances ADsSearchResult to the next entry in the result set obtained by a previous search. This opaque structure will be modified to point to the entry so that the subsequent calls to GetColumn will get columns from this entry. This method does not return or allocate anything and the only effect of this function is to change the state internal to the handle to the next entry.

Exceptions

IADsException failed to perform operation