RCbsTopicCollection Class Reference

class RCbsTopicCollection : public RSubSessionBase

This represents the client-side subsession to retrieve information from topic collections.

Inherits from

Constructor & Destructor Documentation

RCbsTopicCollection()

RCbsTopicCollection()

Constructor.

RCbsTopicCollection(const RCbsTopicCollection &)

RCbsTopicCollection(const RCbsTopicCollection &)[private]

Parameters

const RCbsTopicCollection &

Member Functions Documentation

Close()

TInt Close()

Closes the subsession.

GetTopicCount(TInt &)

voidGetTopicCount(TInt &aCount)

Returns the total amount of topic information the topic collection contains.

Parameters

TInt & aCountIt will contain the amount.

GetTopicInfo(TInt, TCbsTopicInfo &)

TInt GetTopicInfo(TIntaIndex,
TCbsTopicInfo &aInfo
)

Returns a topic information structure.

Parameters

TInt aIndexIt is index to the topic info.
TCbsTopicInfo & aInfoIt will contain the information.

HasNextTopic()

TBool HasNextTopic()

Returns ETrue, if there is a topic not accessed with NextTopic()

NextTopic(TCbsTopicInfo &)

TInt NextTopic(TCbsTopicInfo &aInfo)

Returns the next topic in the topic collection skipping all topics with a topic number matching a topic already listed in the current topic list. This function will return KErrNotFound if the collection is tried to access beyond the end of the list. Otherwise the error code will be the same returned by GetTopicInfo().

Parameters

TCbsTopicInfo & aInfoThe topic information will be stored here.

NotifyOnChange(TRequestStatus &)

voidNotifyOnChange(TRequestStatus &aStatus)

Notifies the client next time when topic collection changes.

Parameters

TRequestStatus & aStatusIt will be changed when topic collection changes.

NotifyOnChangeCancel()

voidNotifyOnChangeCancel()

Cancels the pending request to notify.

Open(RCbs &)

TInt Open(RCbs &aServer)

Creates a subsession to the server.

Note that the method must be called before any other method can be used.

Parameters

RCbs & aServerThe base session.

Start()

voidStart()

Resets the iterator. Must be called prior any call to HasNextTopic() or NextTopic()!

TopicInList(TInt, TBool &)

TInt TopicInList(TIntaIndex,
TBool &aInList
)[private]

Returns information whether the topic was in topic list.

Parameters

TInt aIndexTopic index
TBool & aInListWas the topic in the list

operator=(const RCbsTopicCollection &)

RCbsTopicCollection &operator=(const RCbsTopicCollection &)[private]

Parameters

const RCbsTopicCollection &

Member Data Documentation

TInt iIterator

TInt iIterator[private]