WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsIAbDirectoryQuery

IID:60b5961c-ce61-47b3-aa99-6d865f734dee
Inherits From:nsISupports

This interface is implemented by the following components:

Methods

PRInt32 doQuery ( nsIAbDirectory directory , nsIAbDirectoryQueryArguments arguments , nsIAbDirSearchListener listener , PRInt32 resultLimit , PRInt32 timeOut ) void stopQuery ( PRInt32 contextID )

PRInt32 doQuery ( nsIAbDirectory directory , nsIAbDirectoryQueryArguments arguments , nsIAbDirSearchListener listener , PRInt32 resultLimit , PRInt32 timeOut )

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

Arguments:
directory: A directory that the query may get extra details from.
arguments: The properties and values to match value could of type nsIAbDirectoryQueryMatchItem for matches other than ?contains?
listener: The listener which will obtain individual query results.
resultLimit: Limits the number of results returned to a maximum value.
timeOut: The maximum length of time for the query
Returns:
A context id for the query

void stopQuery ( PRInt32 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

Arguments:
contextID: The unique number returned from the doQuery methods

Reference documentation is generated from Mozilla's source.