InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
CHLUserDictIterator Class Reference
Inheritance diagram for CHLUserDictIterator:
CPMUnknown< IUserDictIterator >IUserDictIteratorIPMUnknown

Public Member Functions

 CHLUserDictIterator (IPMUnknown *boss)
 
virtual bool16 First (IUserDictService *pService, IUserDict *userDict, IUserDictService::WordType nType, WideString *pWord)
 
virtual bool16 Next (WideString *pWord)
 
- Public Member Functions inherited from CPMUnknown< IUserDictIterator >
IPMUnknownQueryInterface (PMIID interfaceID) const
 
void AddRef () const
 
void Release () const
 
void PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
void PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
 CPMUnknown (const CPMUnknown &)=delete
 
CPMUnknownoperator= (const CPMUnknown &)=delete
 

Additional Inherited Members

- Protected Member Functions inherited from CPMUnknown< IUserDictIterator >
 CPMUnknown (IPMUnknown *boss)
 
- Protected Attributes inherited from CPMUnknown< IUserDictIterator >
HelperInterface fHelperInterface
 

Detailed Description

Implements a user dictionary iterator, used to walk all the entries in a single user dictionary.

Member Function Documentation

bool16 CHLUserDictIterator::First (IUserDictServicepService,
IUserDictuserDict,
IUserDictService::WordType nType,
WideStringpWord 
)
virtual

Queries first word in the user dictionary.

Parameters
pServiceuser dict service for the user dictionary.
userDictuser dictionary to query.
nTypeType of the word to query for.
pWord[OUT] first word found in the user dictionary.
Returns
bool16 kTrue if query succeeded.

Implements IUserDictIterator.

bool16 CHLUserDictIterator::Next (WideStringpWord)
virtual

Queries next word in the user dictionary.

Parameters
pWord[OUT] next word found in the user dictionary.
Returns
bool16 kTrue if query succeeded.

Implements IUserDictIterator.