Collapse all Symbian^3 Application Developer Library

Swi::Launcher Class Reference

class Swi::Launcher

Synchronous installation or removal launcher static class.

If you want to perform asynchronous installation, investigate the CAsyncLauncher class defined in asynclauncher.h.

These functions are synchronous, when the function returns the operation is complete.

During the operation and the client does not need to save any status or do anything else after starting installation because all notifications will come via the UI implementation interface.

It should be noted by users of this interface that starting an install causes an instance of a "helper" server to be started in process, sharing the same heap as the client process. This may lead to a number of side effects, including the heap being temporarily inbalanced when the install method returns, due to the delay in the server thread shutting down.

An installer UI should call REComSession::FinalClose() as part of clean up.

CAsyncLauncher

Public Member Functions
IMPORT_C int	Cancel ()
IMPORT_C TInt	Install ( MUiHandler &, const TFileName &, const CInstallPrefs &)
IMPORT_C TInt	Install ( MUiHandler &, MSisDataProvider &, const CInstallPrefs &)
IMPORT_C TInt	Install ( MUiHandler &, RFile &, const CInstallPrefs &)
IMPORT_C TInt	Install ( MUiHandler &, const TFileName &, const CInstallPrefs &, const RArray < TInt > &)
IMPORT_C TInt	Install ( MUiHandler &, RFile &, const CInstallPrefs &, const RArray < TInt > &)
IMPORT_C TInt	Install ( MUiHandler &, MSisDataProvider &, const CInstallPrefs &, const RArray < TInt > &)
IMPORT_C TInt	Uninstall ( MUiHandler &, const TUid &)
IMPORT_C TInt	Uninstall ( MUiHandler &, const CSisRegistryPackage &)

Private Member Functions
TInt	InstallL ( MUiHandler &, const TFileName &, const CInstallPrefs &, const RArray < TInt > &)
TInt	InstallL ( MUiHandler &, RFile &, const CInstallPrefs &, const RArray < TInt > &)
TInt	InstallL ( MUiHandler &, MSisDataProvider &, const CInstallPrefs &, const RArray < TInt > &)
TInt	UninstallL ( MUiHandler &, const CSisRegistryPackage &)

Member Functions Documentation

Cancel()

IMPORT_C int

Cancel

(

)

[static]

Cancels the current operation of Software Install. On cancellation Software Install performs full rollback of the current operation.

Install(MUiHandler &, const TFileName &, const CInstallPrefs &)

IMPORT_C TInt	Install	(	MUiHandler &	aUiHandler,
			const TFileName &	aFileName,
			const CInstallPrefs &	aInstallPrefs
		)	[static]

Starts software installation in case of a locally available SISX file.

An installer UI should call REComSession::FinalClose() as part of clean up.

MUiHandler CInstallPrefs

Parameters

MUiHandler & aUiHandler	UI implementation
const TFileName & aFileName	Local name of the SISX file
const CInstallPrefs & aInstallPrefs	Installation preferences

Install(MUiHandler &, MSisDataProvider &, const CInstallPrefs &)

IMPORT_C TInt	Install	(	MUiHandler &	aUiHandler,
			MSisDataProvider &	aDataProvider,
			const CInstallPrefs &	aInstallPrefs
		)	[static]

Starts software installation with package data provided by means of IPC.

An installer UI should call REComSession::FinalClose() as part of clean up.

MUiHandler MSisDataProvider CInstallPrefs

Parameters

MUiHandler & aUiHandler	UI implementation
MSisDataProvider & aDataProvider	SIS data provider implementation, which may supply data either by reading a file or by streaming
const CInstallPrefs & aInstallPrefs	Installation preferences

Install(MUiHandler &, RFile &, const CInstallPrefs &)

IMPORT_C TInt	Install	(	MUiHandler &	aUiHandler,
			RFile &	aFileHandle,
			const CInstallPrefs &	aInstallPrefs
		)	[static]

Starts software installation with package data provided by means of IPC.

An installer UI should call REComSession::FinalClose() as part of clean up.

Parameters

MUiHandler & aUiHandler	UI implementation
RFile & aFileHandle	File handle of the file to install.
const CInstallPrefs & aInstallPrefs	Installation preferences

Install(MUiHandler &, const TFileName &, const CInstallPrefs &, const RArray< TInt > &)

IMPORT_C TInt	Install	(	MUiHandler &	aUiHandler,
			const TFileName &	aFileName,
			const CInstallPrefs &	aInstallPrefs,
			const RArray < TInt > &	aDeviceSupportedLanguages
		)	[static]

Starts software installation in case of a locally available SISX file.

An installer UI should call REComSession::FinalClose() as part of clean up.

MUiHandler CInstallPrefs

Parameters

MUiHandler & aUiHandler	UI implementation
const TFileName & aFileName	Local name of the SISX file
const CInstallPrefs & aInstallPrefs	Installation preferences
const RArray < TInt > & aDeviceSupportedLanguages	Set of languages which device supports. If the array passed is empty, then the behavior will be same as the Install API without aDeviceSupportedLanguages option.

Install(MUiHandler &, RFile &, const CInstallPrefs &, const RArray< TInt > &)

IMPORT_C TInt	Install	(	MUiHandler &	aUiHandler,
			RFile &	aFileHandle,
			const CInstallPrefs &	aInstallPrefs,
			const RArray < TInt > &	aDeviceSupportedLanguages
		)	[static]

Starts software installation with package data provided by means of IPC.

An installer UI should call REComSession::FinalClose() as part of clean up.

Parameters

MUiHandler & aUiHandler	UI implementation
RFile & aFileHandle	File handle of the file to install.
const CInstallPrefs & aInstallPrefs	Installation preferences
const RArray < TInt > & aDeviceSupportedLanguages	Set of languages which device supports. If the array passed is empty, then the behavior will be same as the Install API without aDeviceSupportedLanguages option.

Install(MUiHandler &, MSisDataProvider &, const CInstallPrefs &, const RArray< TInt > &)

IMPORT_C TInt	Install	(	MUiHandler &	aUiHandler,
			MSisDataProvider &	aDataProvider,
			const CInstallPrefs &	aInstallPrefs,
			const RArray < TInt > &	aDeviceSupportedLanguages
		)	[static]

Starts software installation with package data provided by means of IPC.

An installer UI should call REComSession::FinalClose() as part of clean up.

MUiHandler MSisDataProvider CInstallPrefs

Parameters

MUiHandler & aUiHandler	UI implementation
MSisDataProvider & aDataProvider	SIS data provider implementation, which may supply data either by reading a file or by streaming
const CInstallPrefs & aInstallPrefs	Installation preferences
const RArray < TInt > & aDeviceSupportedLanguages	Set of languages which device supports. If the array passed is empty, then the behavior will be same as the Install API without aDeviceSupportedLanguages option.

InstallL(MUiHandler &, const TFileName &, const CInstallPrefs &, const RArray< TInt > &)

TInt	InstallL	(	MUiHandler &	aUiHandler,
			const TFileName &	aFileName,
			const CInstallPrefs &	aInstallPrefs,
			const RArray < TInt > &	aDeviceSupportedLanguages
		)	[private, static]

Parameters

MUiHandler & aUiHandler
const TFileName & aFileName
const CInstallPrefs & aInstallPrefs
const RArray < TInt > & aDeviceSupportedLanguages

InstallL(MUiHandler &, RFile &, const CInstallPrefs &, const RArray< TInt > &)

TInt	InstallL	(	MUiHandler &	aUiHandler,
			RFile &	aFileHandle,
			const CInstallPrefs &	aInstallPrefs,
			const RArray < TInt > &	aDeviceSupportedLanguages
		)	[private, static]

Parameters

MUiHandler & aUiHandler
RFile & aFileHandle
const CInstallPrefs & aInstallPrefs
const RArray < TInt > & aDeviceSupportedLanguages

InstallL(MUiHandler &, MSisDataProvider &, const CInstallPrefs &, const RArray< TInt > &)

TInt	InstallL	(	MUiHandler &	aUiHandler,
			MSisDataProvider &	aDataProvider,
			const CInstallPrefs &	aInstallPrefs,
			const RArray < TInt > &	aDeviceSupportedLanguages
		)	[private, static]

Parameters

MUiHandler & aUiHandler
MSisDataProvider & aDataProvider
const CInstallPrefs & aInstallPrefs
const RArray < TInt > & aDeviceSupportedLanguages

Uninstall(MUiHandler &, const TUid &)

IMPORT_C TInt	Uninstall	(	MUiHandler &	aUiHandler,
			const TUid &	aUid
		)	[static]

Uninstalls the main package identified by UID, and all the augmentations associated with this package.

MUiHandler

Parameters

MUiHandler & aUiHandler	UI implementation
const TUid & aUid	UID of the application to remove

Uninstall(MUiHandler &, const CSisRegistryPackage &)

IMPORT_C TInt	Uninstall	(	MUiHandler &	aUiHandler,
			const CSisRegistryPackage &	aPackage
		)	[static]

Uninstalls a specific package.

MUiHandler

Parameters

MUiHandler & aUiHandler	UI implementation
const CSisRegistryPackage & aPackage	The specific package to uninstall.

UninstallL(MUiHandler &, const CSisRegistryPackage &)

TInt	UninstallL	(	MUiHandler &	aUiHandler,
			const CSisRegistryPackage &	aPackage
		)	[private, static]

Parameters

MUiHandler & aUiHandler
const CSisRegistryPackage & aPackage