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.

nsIMsgSearchSession

IID:a819050a-0302-11d3-a50a-0060b0fc04b7
Inherits From:nsISupports

This interface is implemented by the following components:

Constants

PRInt32 BooleanOR = 0
PRInt32 BooleanAND = 1

Properties

readonly PRInt32 numResults

readonly PRUint32 numSearchTerms

readonly nsIMsgSearchAdapter runningAdapter

readonly voidPtr* searchParam

readonly nsISupportsArray searchTerms

readonly nsMsgSearchType* searchType

nsIMsgWindow window

Methods

void AddAllScopes ( nsMsgSearchScopeValue attrib ) void addDirectoryScopeTerm ( nsMsgSearchScopeValue scope ) [noscript] void AddResultElement ( nsMsgResultElement* element ) void addScopeTerm ( nsMsgSearchScopeValue scope , nsIMsgFolder folder ) void addSearchHit ( nsIMsgDBHdr header , nsIMsgFolder folder ) void addSearchTerm ( nsMsgSearchAttribValue attrib , nsMsgSearchOpValue op , nsIMsgSearchValue value , PRBool BooleanAND , char* arbitraryHeader ) void appendTerm ( nsIMsgSearchTerm term ) void clearScopes ( ) PRInt32 countSearchScopes ( ) nsIMsgSearchTerm createTerm ( ) void getNthSearchScope ( PRInt32 which , out nsMsgSearchScopeValue scopeId , out nsIMsgFolder folder ) void getNthSearchTerm ( PRInt32 whichTerm , nsMsgSearchAttribValue attrib , nsMsgSearchOpValue op , nsIMsgSearchValue value ) void interruptSearch ( ) PRBool IsStringAttribute ( nsMsgSearchAttribValue attrib ) PRBool MatchHdr ( nsIMsgDBHdr msgHdr , nsIMsgDatabase database ) void pauseSearch ( ) void registerListener ( nsIMsgSearchNotify listener ) void resumeSearch ( ) [noscript] PRBool ScopeUsesCustomHeaders ( nsMsgSearchScopeValue scope , voidPtr* selection , PRBool forFilters ) void search ( nsIMsgWindow window ) [noscript] nsMsgSearchType* SetSearchParam ( nsMsgSearchType* type , voidPtr* param ) void unregisterListener ( nsIMsgSearchNotify listener )

void AddAllScopes ( nsMsgSearchScopeValue attrib )

Arguments:
attrib

void addDirectoryScopeTerm ( nsMsgSearchScopeValue scope )

Arguments:
scope

void AddResultElement ( nsMsgResultElement* element )

Arguments:
element

void addScopeTerm ( nsMsgSearchScopeValue scope , nsIMsgFolder folder )

Arguments:
scope
folder

void addSearchHit ( nsIMsgDBHdr header , nsIMsgFolder folder )

Arguments:
header
folder

void addSearchTerm ( nsMsgSearchAttribValue attrib , nsMsgSearchOpValue op , nsIMsgSearchValue value , PRBool BooleanAND , char* arbitraryHeader )

Arguments:
attrib
op
value
BooleanAND
arbitraryHeader

void appendTerm ( nsIMsgSearchTerm term )

Arguments:
term

void clearScopes ( )

PRInt32 countSearchScopes ( )

nsIMsgSearchTerm createTerm ( )

void getNthSearchScope ( PRInt32 which , out nsMsgSearchScopeValue scopeId , out nsIMsgFolder folder )

Arguments:
which
scopeId
folder

void getNthSearchTerm ( PRInt32 whichTerm , nsMsgSearchAttribValue attrib , nsMsgSearchOpValue op , nsIMsgSearchValue value )

Arguments:
whichTerm
attrib
op
value

void interruptSearch ( )

PRBool IsStringAttribute ( nsMsgSearchAttribValue attrib )

Arguments:
attrib

PRBool MatchHdr ( nsIMsgDBHdr msgHdr , nsIMsgDatabase database )

Arguments:
msgHdr
database

void pauseSearch ( )

void registerListener ( nsIMsgSearchNotify listener )

Arguments:
listener

void resumeSearch ( )

PRBool ScopeUsesCustomHeaders ( nsMsgSearchScopeValue scope , voidPtr* selection , PRBool forFilters )

Arguments:
scope
selection
forFilters

void search ( nsIMsgWindow window )

Arguments:
window

nsMsgSearchType* SetSearchParam ( nsMsgSearchType* type , voidPtr* param )

Arguments:
type
param

void unregisterListener ( nsIMsgSearchNotify listener )

Arguments:
listener

References

This interface is the type of the following properties:

nsIMsgDBView.searchSession, nsIMsgMailNewsUrl.searchSession, nsIMsgSearchScopeTerm.searchSession

This interface is passed as an argument to the following methods:

nsIMsgMessageService.Search

Reference documentation is generated from Mozilla's source.

Copyright © 1999-2006 XULPlanet.com