Class RSyncMLSettings

class RSyncMLSettings : public RSubSessionBase;

Description

Handle to global settings for SyncML sync behaviour.

Derivation

• RSubSessionBase - Client-side handle to a sub-session.

• RSyncMLSettings - Handle to global settings for SyncML sync behaviour.

Members

Defined in RSyncMLSettings:

• Close()Closes the settings handle.
• GetValueL(TSmlGlobalSetting)constGets the current value for the specified setting.
• OpenL(RSyncMLSession &)Opens a handle to the SyncML global settings.
• SetValueL(TSmlGlobalSetting,TInt)Sets the current value of the specified setting.

Inherited from RSubSessionBase:

• CloseSubSession(TInt)Closes the sub-session.
• CreateAutoCloseSubSession(RSessionBase &,TInt,const TIpcArgs &)Creates a new sub-session within an existing session. The new sub-session takes ...
• CreateSubSession(const RSessionBase &,TInt)Creates a new sub-session within an existing session.
• CreateSubSession(const RSessionBase &,TInt,const TIpcArgs &)Creates a new sub-session within an existing session.
• Send(TInt)constSends a blind message to the server - no reply is expected.
• Send(TInt,const TIpcArgs &)constSends a blind message to the server - no reply is expected.
• SendReceive(TInt)constSends a message to the server and waits synchronously for a reply.
• SendReceive(TInt,TRequestStatus &)constSends a message to the server and waits asynchronously for the reply.
• SendReceive(TInt,const TIpcArgs &)constSends a message to the server and waits synchronously for a reply.
• SendReceive(TInt,const TIpcArgs &,TRequestStatus &)constSends a message to the server and waits asynchronously for the reply.
• Session()constReturns a copy of the session associated with this sub-session.
• SubSessionHandle()constGets the sub-session handle number.

See also:

• TSmlGlobalSettingGlobal settings supported by the RSyncMLSettings class.

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.

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.

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.

IMPORT_C void Close();

Description

Closes the settings handle.