Class TShgNameIter

class TShgNameIter;

Description

An iterator over a name set (CShgNameSet).

Members

Defined in TShgNameIter:
Current(), Reset(), TShgNameIter(), operator++()

IMPORT_C TShgNameIter(const CShgNameSet *aNameSet, TBool aIncludePermanentlyDeletedNames=EFalse);

Description

Constructor.

Parameters

const CShgNameSet *aNameSet Name set to iterate TBool aIncludePermanentlyDeletedNames Include permanently deleted names in the iteration

IMPORT_C void Reset();

Description

Resets the iterator to the start of the set.

IMPORT_C TInt Current();

Description

Gets the index of the current name.

The index value can be used with CShgNameSet's operator[].

Return value

TInt Index of the current name. This is a negative value when the iteration has completed.

IMPORT_C TInt operator++();

Description

Increments the iterator.

Return value

TInt Incremented name set index. This is a negative value when the iteration has completed.