Collapse all Symbian^3 Application Developer Library

MCatalogsEngine Class Reference

class MCatalogsEngine : public MCatalogsBase

An interface providing the main handle to Catalogs engine

This class offers functionality for provider creation

Inherits from

MCatalogsEngine
- MCatalogsBase

Public Member Functions
void	CancelProviderCreation ()
void	Close ()
TInt	Connect ( TUid )
void	CreateProviderL ( TInt , MCatalogsBase *&, TRequestStatus &, TUint32 )

Protected Member Functions
	~MCatalogsEngine ()

Constructor & Destructor Documentation

~MCatalogsEngine()

~MCatalogsEngine

(

)

[protected, inline, virtual]

Destructor.

MCatalogsBase::~MCatalogsBase

Member Functions Documentation

CancelProviderCreation()

void

CancelProviderCreation

(

)

[pure virtual]

Cancels provider creation.

Note:

Completes the ongoing provider creation immediately with KErrCancel.

Close()

void

(

)

[pure virtual]

Close connection to the Catalogs engine.

Note:

All references to Catalogs Engine objects must be released before closing the session.

MCatalogsEngine::Connect

Exceptions

ECatalogsPanicUnreleasedReferencesExist

Raised if unreleased references still exist to objects within the Catalogs Engine.

Connect(TUid)

TInt

Connect

(

TUid

aClientUid

)

[pure virtual]

Connect to the Catalogs engine. Content and services provided by the engine depend on the client application's UID given as a parameter.

Note:

Once opened, the connection must be closed with MCatalogsEngine::Close() before the engine object can be released. Panic ECatalogsPanicSessionNotClosed will be raised if the connection is still open when the engine object is released.

MCatalogsEngine::Close

Parameters

TUid aClientUid

Client identifier, used for content access control.

CreateProviderL(TInt, MCatalogsBase *&, TRequestStatus &, TUint32)

void	CreateProviderL	(	TInt	aUid,
			MCatalogsBase *&	aProvider,
			TRequestStatus &	aStatus,
			TUint32	aProviderOptions
		)	[pure virtual]

Requests a provider from the Catalogs engine. Specific provider implementations are identified by UIDs. Currently only one provider is supported: NCD provider (uid=0x20008013)

MNcdProvider ncdprovideroptions.h

Exceptions

Leave

System wide error code.

ncderrors.h For possible provider creation complition codes other than KErrNone

Note:

NCD provider uses Download manager in master mode with the connecting client's SID. This prevents the client from using Download manager with it's own SID in master mode. If the client needs to use Download manager in master mode, it must connect to it with some other UID than its own SID.

aProviderOptions has effect only during the first CreateProviderL call so if the client calls CreateProviderL twice during its execution, the provider will be unaffected by the second call.

Parameters

TInt aUid	Unique identifier of the provider that should be created.
MCatalogsBase *& aProvider	Set to point to the newly created provider object. Counted, Release() must be called after use.
TRequestStatus & aStatus	Status variable used to notify the completion of provider creation.
TUint32 aProviderOptions	Provider spesific options