Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: SyncMLClient.h
Link against: smlclient.lib

This item is not part of the S60 3rd Edition SDK for Symbian OS, Feature Pack 2.

Class RSyncMLSettings

class RSyncMLSettings : public RSubSessionBase;

Description

Handle to global settings for SyncML sync behaviour.

Derivation

Members

Defined in RSyncMLSettings:
Close(), GetValueL(), OpenL(), SetValueL()

Inherited from RSubSessionBase:
CloseSubSession(), CreateAutoCloseSubSession(), CreateSubSession(), Send(), SendReceive(), Session(), SubSessionHandle()

See also:


Member functions


OpenL()

IMPORT_C void OpenL(RSyncMLSession &);

Description

Opens a handle to the SyncML global settings.

Parameters

RSyncMLSession &

An open session with the Sync Agent.

Leave codes

System

error codes.


GetValueL()

IMPORT_C TInt GetValueL(TSmlGlobalSetting) const;

Pre-Condition

The handle is open.

Description

Gets the current value for the specified setting.

Parameters

TSmlGlobalSetting

The setting to retrieve.

Return value

TInt

The current setting value.

Leave codes

KErrArgument

The setting is unknown.

System

error codes.


SetValueL()

Capability: WriteDeviceData

IMPORT_C void SetValueL(TSmlGlobalSetting, TInt aValue);

Pre-Condition

The handle is open.

Description

Sets the current value of the specified setting.

Parameters

TSmlGlobalSetting

The setting to set.

TInt aValue

The new value for the setting.

Leave codes

KErrArgument

The setting is unknown, or the value is out of range.

System

error codes.


Close()

IMPORT_C void Close();

Description

Closes the settings handle.