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 RSyncMLDataProvider

class RSyncMLDataProvider : public RSubSessionBase;

Description

Handle to information about an available SyncML data provider.

Derivation

Members

Defined in RSyncMLDataProvider:

Inherited from RSubSessionBase:


Construction and destruction


RSyncMLDataProvider()

IMPORT_C RSyncMLDataProvider();

Description

Default constructor.

[Top]


Member functions


OpenL(RSyncMLSession &,TSmlDataProviderId)

IMPORT_C void OpenL(RSyncMLSession &, TSmlDataProviderId);

Description

Opens a handle on the data provider identified by aId.

Parameters

RSyncMLSession &

An open session with the Sync Agent.

TSmlDataProviderId

The ID of the data provider to open.

Leave codes

SyncMLError::KErrDataProviderNotFound

The specified data provider ID does not represent a valid data provider.

KErrNoMemory

Insufficient system memory to complete the operation.

System

error codes.


Identifier()const

IMPORT_C TSmlDataProviderId Identifier() const;

Pre-Condition

The handle is open.

Description

Gets the ID of the data provider referenced by this handle.

Return value

TSmlDataProviderId

The data provider ID.


Version()const

IMPORT_C TVersion Version() const;

Pre-Condition

The handle is open.

Description

Gets the version of the data provider referenced by this handle.

Return value

TVersion

The version of the data provider.


DisplayName()const

IMPORT_C const TDesC& DisplayName() const;

Pre-Condition

The handle is open.

Description

Gets the human-readable display name of the data provider referenced by this handle.

Return value

const TDesC16 &

The name of the data provider.


MimeTypeCount()const

IMPORT_C TInt MimeTypeCount() const;

Pre-Condition

The handle is open.

Description

Gets the count of mime types supported by the data provider referenced by this handle.

Return value

TInt

The number of mime types.


MimeType(TInt)const

IMPORT_C const TDesC8& MimeType(TInt aIndex) const;

Pre-Condition

The handle is open.

Description

Gets the mime type at position aIndex for the data provider referenced by this handle.

Parameters

TInt aIndex

The array index position.

Return value

const TDesC8 &

The mime type.


MimeVersion(TInt)const

IMPORT_C const TDesC8& MimeVersion(TInt aIndex) const;

Pre-Condition

The handle is open.

Description

Gets the version of the mime type at position aIndex for the data provider referenced by this handle.

Parameters

TInt aIndex

The array index position.

Return value

const TDesC8 &

The mime type version.


DefaultDataStoreName()const

IMPORT_C const TDesC& DefaultDataStoreName() const;

Pre-Condition

The handle is open.

Description

Gets the name of the default data store for the data provider referenced by this handle.

Return value

const TDesC16 &

The name of the default data store.


AllowsMultipleDataStores()const

IMPORT_C TBool AllowsMultipleDataStores() const;

Pre-Condition

The handle is open.

Description

Tests if the data provider supports only a single data store.

Return value

TBool

Zero if the data provider supports only a single data store.


GetDataStoreNamesL(CDesCArray &)const

IMPORT_C void GetDataStoreNamesL(CDesCArray &) const;

Pre-Condition

The handle is open.

Description

Gets a list of existing data stores for the data provider referenced by this handle.

Parameters

CDesC16Array &

An array to be populated with store names.

Leave codes

KErrNoMemory

Insufficient system memory to complete the operation.

System

error codes.


SupportedServerFiltersL(RPointerArray< CSyncMLFilter > &)const

IMPORT_C void SupportedServerFiltersL(RPointerArray< CSyncMLFilter > &aFilterArray) const;

Description

Parameters

RPointerArray< CSyncMLFilter > &aFilterArray


RequiredProtocolVersionL()const

IMPORT_C TSmlProtocolVersion RequiredProtocolVersionL() const;

Description

Returns the protocol version required to support this data provider.

KErrNotSupported This method is not currently supported.

Return value

TSmlProtocolVersion

Protocol version require to support this data provider.


Close()

IMPORT_C void Close();

Description

Closes this handle.