Symbian
Symbian Developer Library

SYMBIAN OS V9.4

Feedback

[Index] [Previous] [Next]

#include <SyncMLClientDS.h>
Link against: smlclient.lib
This item is not part of the S60 5th Edition SDK

Class RSyncMLDataSyncProfile

class RSyncMLDataSyncProfile : public RSyncMLProfileBase;

Description

Handle to a SyncML Data Synchronisation profile.

A profile encapsulates a relationship with a single SyncML remote server, and contains a number of 'tasks' and 'connections'.

Derivation

Members

Defined in RSyncMLDataSyncProfile:

Inherited from RSubSessionBase:

Inherited from RSyncMLProfileBase:


Construction and destruction


RSyncMLDataSyncProfile()

IMPORT_C RSyncMLDataSyncProfile();

Description

Default constructor.

[Top]


Member functions


CreateL(RSyncMLSession &)

Capability: WriteDeviceData

IMPORT_C void CreateL(RSyncMLSession &);

Description

Creates a new, blank, profile for Data Synchronisation and opens this object as a handle to it.

The new profile will not be saved until UpdateL is called.

Parameters

RSyncMLSession &

An open session with the Sync Agent.

Leave codes

System

error codes.


OpenL(RSyncMLSession &,TSmlProfileId,TSmlOpenMode)

Capability: Dependent See enum TSmlOpenMode for required capabilities.

IMPORT_C void OpenL(RSyncMLSession &, TSmlProfileId, TSmlOpenMode);

Description

Opens a handle to an existing Data Synchronisation profile of the specified ID.

Parameters

RSyncMLSession &

An open session with the Sync Agent.

TSmlProfileId

The ID of the profile to open.

TSmlOpenMode

The access mode to open the profile in, read-only, or read and write.

Leave codes

System

error codes.

SyncMLError::KErrProfileNotFound

The specified profile ID does not represent a valid profile.


ListTasksL(RArray< TSmlTaskId > &)const

IMPORT_C void ListTasksL(RArray< TSmlTaskId > &) const;

Pre-Condition

The handle is open.

Description

Gets a list of IDs of tasks defined for this profile.

Parameters

RArray< TSmlTaskId > &

An array to populate with IDs.

Leave codes

System

error codes.


DeleteTaskL(TSmlTaskId)

IMPORT_C void DeleteTaskL(TSmlTaskId);

Pre-Condition

The handle is open for read and write access.

Description

Deletes the task identified by aId from this profile.

Parameters

TSmlTaskId

The ID of the connection to delete.

Leave codes

System

error codes.