Public Member Functions

nsIAbDirectorySearch Interface Reference

Searching of cards on a directory. More...

import "nsIAbDirectorySearch.idl";

List of all members.

Public Member Functions

void startSearch ()
 Starts a search on the directory.
void stopSearch ()
 Stops a search on the directory.

Detailed Description

Searching of cards on a directory.

The search data is defined in the query section of the directory URI, for example

moz-abldapdirectory://ldap1.holland/dc=sun,dc=com?<query>

If no search data is defined then the methods will return immediately with no error.


Member Function Documentation

void nsIAbDirectorySearch::startSearch (  ) 

Starts a search on the directory.

If a search is already being performed it is stopped.

The results from a search, cards, will returned by informing the address book session that a new card has been added to the directory.

The nsIAbDirectoryQuery implementation of the directory component (or a proxy) may be used as an implementation for this specialization of query.

This method is semantically equivalent to the nsIAbDirectory.getChildCards method when there is search criteria defined in the directory uri.

void nsIAbDirectorySearch::stopSearch (  ) 

Stops a search on the directory.


The documentation for this interface was generated from the following file: