Collapse all Symbian^3 Application Developer Library

MSmlSyncRelationship Class Reference

class MSmlSyncRelationship

SyncML store interface exposed to Database Adaptor implementations. This interface may be used by a DBA to store change information for a Data Store, in the context of a sync relationship with a remote Data Store. It is vital for correct synchronisation behaviour that change information is stored separately for different remote Data Stores. This interface facilitates this by providing streams that are stored against specific Sync Tasks, and a unique key that identifies the sync relationship.

Public Member Functions
TBool	IsStreamPresentL ( TUid )
void	OpenReadStreamLC ( RReadStream &, TUid )
void	OpenWriteStreamLC ( RWriteStream &, TUid )
TSmlSyncTaskKey	SyncTaskKey ()

Member Functions Documentation

IsStreamPresentL(TUid)

TBool

IsStreamPresentL

(

TUid

aStreamUid

)

const [pure virtual]

Tests if the specified stream identified exists in the store.

Parameters

TUid aStreamUid

The stream UID

OpenReadStreamLC(RReadStream &, TUid)

void	OpenReadStreamLC	(	RReadStream &	aReadStream,
			TUid	aStreamUid
		)	[pure virtual]

Opens a specified stream for reading, and places an item on the cleanup stack to close it.

Parameters

RReadStream & aReadStream	On return, an open read stream
TUid aStreamUid	The UID of the stream to open for reading.

OpenWriteStreamLC(RWriteStream &, TUid)

void	OpenWriteStreamLC	(	RWriteStream &	aWriteStream,
			TUid	aStreamUid
		)	[pure virtual]

Opens the specified stream, or creates a new one if it does not exist, and places an item on the cleanup stack to close it.

Parameters

RWriteStream & aWriteStream	On return, an open write stream
TUid aStreamUid	The UID of the stream to open or create

SyncTaskKey()

TSmlSyncTaskKey

SyncTaskKey

(

)

const [pure virtual]

Returns the unique identifier for the synchronisation relationship.