Public Member Functions

nsIAbDirectoryQuery Interface Reference

import "nsIAbDirectoryQuery.idl";

Inheritance diagram for nsIAbDirectoryQuery:

List of all members.

Public Member Functions

long doQuery (in nsIAbDirectory aDirectory, in nsIAbDirectoryQueryArguments aArguments, in nsIAbDirSearchListener aListener, in long aResultLimit, in long aTimeOut)
 Initiates a query on a directory and sub-directories for properties on cards.
void stopQuery (in long contextID)
 Stops an existing query operation if query operation is asynchronous.

Member Function Documentation

long nsIAbDirectoryQuery::doQuery ( in nsIAbDirectory  aDirectory,
in nsIAbDirectoryQueryArguments  aArguments,
in nsIAbDirSearchListener  aListener,
in long  aResultLimit,
in long  aTimeOut 
)

Initiates a query on a directory and sub-directories for properties on cards.

Parameters:
aDirectory A directory that the query may get extra details from.
aArguments The properties and values to match value could of type nsIAbDirectoryQueryMatchItem for matches other than ?contains?
aListener The listener which will obtain individual query results.
aResultLimit Limits the number of results returned to a maximum value.
aTimeOut The maximum length of time for the query
Returns:
A context id for the query
void nsIAbDirectoryQuery::stopQuery ( in long  contextID  ) 

Stops an existing query operation if query operation is asynchronous.

The nsIAbDirectoryQueryResultListener will be notified when query has stopped

It is implementation specific if notification synchronous or asynchronous

Parameters:
contextID The unique number returned from the doQuery methods

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