Symbian
Symbian OS Library

SYMBIAN OS V9.3

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



Location: SyncMLClientDM.h
Link against: smlclient.lib

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

Class RSyncMLDevManJob

class RSyncMLDevManJob : public RSyncMLJobBase;

Description

Handle to a device management job.

A device management job is used to create, access, modify or remove device settings stored in the device repository.

Derivation

Members

Defined in RSyncMLDevManJob:
CreateL(), CreateL(), OpenL(), RSyncMLDevManJob(), StopL()

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

Inherited from RSyncMLJobBase:
Close(), Identifier(), Profile()


Construction and destruction


RSyncMLDevManJob()

IMPORT_C RSyncMLDevManJob();

Description

Default constructor.

[Top]


Member functions


CreateL()

Capability: LocalServices
Capability: NetworkServices

IMPORT_C void CreateL(RSyncMLSession &, TSmlProfileId);

Pre-Condition

The session is open.

Description

Creates and queues a new device management job based on the specified device management profile.

This object is opened as a handle to the new job.

Parameters

RSyncMLSession &

An open session with the Sync Agent.

TSmlProfileId

The ID of the profile.

Leave codes

System

error codes.

SyncMLError::KErrProfileNotFound

The specified profile was not found.

SyncMLError::KErrTransportNotFound

The specified profile contains no connections, or a connection over an unknown transport.

SyncMLError::KErrSuspended

The SyncML framework is suspended pending a system backup or restore.

KErrArgument

The specified profile is not a DevMan profile.


CreateL()

Capability: LocalServices
Capability: NetworkServices

IMPORT_C void CreateL(RSyncMLSession &, TSmlProfileId, TSmlConnectionId);

Pre-Condition

The session is open.

Description

Creates and queues a new device management job based on the specified device management profile, using the specified connection method.

This object is opened as a handle to the new job.

Parameters

RSyncMLSession &

An open session with the Sync Agent.

TSmlProfileId

The ID of the profile.

TSmlConnectionId

The ID of the connection method to use.

Leave codes

System

error codes.

SyncMLError::KErrProfileNotFound

The specified profile was not found.

SyncMLError::KErrTransportNotFound

The specified profile contains no connections, or a connection over an unknown transport.

SyncMLError::KErrSuspended

The SyncML framework is suspended pending a system backup or restore.

KErrArgument

The specified profile is not a DevMan profile.


OpenL()

IMPORT_C void OpenL(RSyncMLSession &, TSmlJobId);

Pre-Condition

The session is open.

Description

Open a handle to a queued device management job of the specified ID.

Parameters

RSyncMLSession &

An open session with the Sync Agent.

TSmlJobId

The ID of the job to open.

Leave codes

System

error codes.


StopL()

Capability: Security policy note: Policed on LocalServices or NetworkServices depending on the bearer used for the job. HTTP/TCPIP NetworkServices WSP/UDP NetworkServices OBEX/BT LocalServices OBEX/IrDA LocalServices OBEX/USB LocalServices

IMPORT_C void StopL();

Pre-Condition

The handle is open.

Description

Abort the job this handle refers to, stopping the job if it is in progress, and removing it from the queue.

Leave codes

System

error codes.