Swi

Public Attributes
const TInt	FileNameUnadornedPartLength
const TLitC8< sizeof("AllowGrantUserCapabilities")>	KAllowGrantUserCaps
const TLitC8< sizeof("AllowOrphanedOverwrite")>	KAllowOrphanedOverwrite
const TLitC8< sizeof("AllowOverwriteOnRestore")>	KAllowOverwriteOnRestore
const TLitC8< sizeof("AllowPackagePropagate")>	KAllowPackagePropagate
const TLitC8< sizeof("AllowProtectedOrphanOverwrite")>	KAllowProtectedOrphanOverwrite
const TLitC8< sizeof("AllowRunOnInstallUninstall")>	KAllowRunOnInstallUninstall
const TLitC8< sizeof("AllowUnsigned")>	KAllowUnsigned
const TLitC8< sizeof("AlternativeCodeSigningOID")>	KAlternativeCodeSigningOid
const TLitC8< sizeof("ApplicationShutdownTimeoutSeconds")>	KApplicationShutdownTimeout
const TLitC8< sizeof("DRMEnabled")>	KDRMEnabled
const TLitC8< sizeof("DRMIntent")>	KDRMIntent
const TUint8	KDataField
const TLitC8< sizeof("DeletePreinstalledFilesOnUninstall")>	KDeletePreinstalledFilesOnUninstall
const TUint8	KHeaderField
const TLitC< sizeof(L"InstallServer")/2 >	KInstallServerImage
const TLitC< sizeof(L"!InstallServer")/2 >	KInstallServerName
const TUid	KInstallServerUid3
const TInt	KInstallServerVersionBuild
const TInt	KInstallServerVersionMajor
const TInt	KInstallServerVersionMinor
const TLitC8< sizeof("MandateCodeSigningExtension")>	KMandateCodeSigningExtension
const TLitC8< sizeof("MandatePolicies")>	KMandatePolicies
const TInt	KMaxExpressionDepth
const TInt	KMaxLogFileName
const TInt	KMaxNoOfDeletionAttempts
const TLitC8< sizeof("MaxNumOfLogEntries")>	KMaxNumOfLogEntries
const TInt	KMaxUidCount
const TLitC8< sizeof("OcspEnabled")>	KOcspEnabled
const TLitC8< sizeof("OcspHttpHeaderFilter")>	KOcspHttpHeaderFilter
const TLitC8< sizeof("OcspMandatory")>	KOcspMandatory
const TLitC8< sizeof("Oid")>	KOid
const TLitC8< sizeof("PhoneTsyName")>	KPhoneTsyName
const TInt	KProgressBarEndIncrement
const TInt	KProgressBarIncrement
const TInt	KProgressBarInstallChunkSize
const TInt	KProgressBarUninstallAmount
const TLitC8< sizeof("RemoveOnlyWithLastDependent")>	KRemoveOnlyWithLastDependent
const TLitC8< sizeof("ReplacePath")>	KReplacePath
const TInt	KRetryInterval
const TLitC8< sizeof("RunWaitTimeoutSeconds")>	KRunWaitTimeout
const TLitC8< sizeof("SISCompatibleIfNoTargetDevices")>	KSISCompatibleIfNoTargetDevices
const TInt	KSWIObserverRetryDelay
const TUid	KSisHelperServerUid3
const TInt	KSisHelperVersionBuild
const TInt	KSisHelperVersionMajor
const TInt	KSisHelperVersionMinor
const TInt	KSwiObserverShutdownPeriod
const TInt	KSwiObserverVerBuild
const TInt	KSwiObserverVerMajor
const TInt	KSwiObserverVerMinor
const TUint	KSwisOperationMask
const TUint	KSwisOperationStatusMask
const TLitC< sizeof(L"z:\\system\\data\\swipolicy.ini")/2 >	KSwisPolicyFile
const TUint	KUidSoftwareInstallKey
const TUid	KUidSwiObserver
const TLitC8< sizeof("UserCapabilities")>	KUserCapabilities
const TInt	KVariableLanguage
const TInt	KVariableRemoteInstall

Public Member Enumerations
enum	StateMachinePanic { EStateError }
enum	TDevCertWarningState { ENoDevCerts, EFoundDevCerts, EDevCertsWarned }
enum	TErrorDialog { EUiAlreadyInRom, EUiMissingDependency, EUiRequireVer, EUiRequireVerOrGreater, ..., EUiBlockingEclipsingFile }
enum	TFileFlag { EFileAdded, EFileDeleted, EFileDll, EFileExe }
enum	TFileTextOption { EInstFileTextOptionContinue, EInstFileTextOptionSkipOneIfNo, EInstFileTextOptionAbortIfNo, EInstFileTextOptionExitIfNo, EInstFileTextOptionForceAbort }
enum	TFlagFileOperation { EDeleteFlagFile, ECreateFlagFile }
enum	TInstallCancellableEvent { EEventRemovingFiles, EEventShuttingDownApps, EEventCopyingFiles, EEventOcspCheckStart }
enum	TInstallEvent { EEventSetProgressBarFinalValue, EEventUpdateProgressBar, EEventAbortedInstall, EEventCompletedInstall, ..., EEventDevCert }
enum	TInstallServerMessage { EInstall, EUninstall, ECancel, ERestore, ..., ERemoveUnInstalledPkg }
enum	TInstallServerPanic { EPanicInstallServerBadDescriptor, EPanicInstallServerIllegalFunction }
enum	TIntegrityServicesEvent { ENone, ERemovedFile, EBackupFile, ETempFile, ..., ETempFilesRemoved }
enum	TOperationType { EOpInstall, EOpUninstall, EOpRestore }
enum	TPackageType { EStandardApplication, EStandardPatch, EPartialUpgrade, EPreinstalledApplication, ..., EUnknownPackage }
enum	TQuestionDialog { EQuestionIncompatible, EQuestionOverwriteFile }
enum	TRestoreFileMessage { EMessageSlotRestoreFs, EMessageSlotRestoreFile, EMessageSlotRestorePath }
enum	TRestoreMessage { EMessageSlotRestoreUid, EMessageSlotRestoreController }
enum	TRevocationDialogMessage { EInvalidRevocationServerUrl, EUnableToObtainCertificateStatus, EResponseSignatureValidationFailure, EInvalidRevocationServerResponse, ..., ECertificateStatusIsRevoked }
enum	TRevocationStatus { EUnknown2, EOcspNotPerformed, EOcspRevoked, EOcspUnknown, ..., EOcspGood }
enum	TSignatureValidationResult { EValidationSucceeded, ESignatureSelfSigned, ENoCertificate, ECertificateValidationError, ..., EMandatorySignatureMissing }
enum	TSisHelperMessage { ESisHelperGetController, ESisHelperExtractFile, ESisHelperFillDrivesAndSpaces, ESisHelperOpenDrmContent, ..., ESisHelperGetEquivalentLanguages }
enum	TSisHelperPanic { EPanicBadDescriptor, EPanicIllegalFunction, EPanicAlreadyReceiving, EPanicBadStartupDataType, EPanicBadDataProvider }
enum	TSisPackageTrust { ESisPackageUnsignedOrSelfSigned, ESisPackageValidationFailed, ESisPackageCertificateChainNoTrustAnchor, ESisPackageCertificateChainValidatedToTrustAnchor, ..., ESisPackageBuiltIntoRom }
enum	TSwiLogTypes { ESwiLogInstall, ESwiLogUnInstall, ESwiLogUpgrade, ESwiLogRestore }
enum	TSwiObserverFunction { ERegisterToObserver, ETransferFileHandle, ESwiCommit }
enum	TSwisOperation { ESwisNone, ESwisInstall, ESwisUninstall, ESwisRestore }
enum	TSwisOperationStatus { ESwisStatusNone, ESwisStatusSuccess, ESwisStatusAborted }
enum	TValidationStatus { EUnknown, EExpired, EInvalid, EUnsigned, ..., EPackageInRom }

Public Member Functions
void	CopyArrayL(RArray< T > &, const RArray< T > &)
void	CopyPointerArrayL(RPointerArray< T > &, const RPointerArray< T > &)
void	ExternalizeArrayL(const RArray< T > &, RWriteStream &)
void	ExternalizePointerArrayL(const RPointerArray< T > &, RWriteStream &)
void	FindAllAdornedVariantsL(RFs &, const TDesC &, const TDesC &, RPointerArray< HBufC > &)
void	GenerateSearchNameWildL(const TDesC &, TDes &)
IMPORT_C TInt	GetAllUids(RArray< TUid > &)
void	GetUnadornedFileName(const TDesC &, TDes &)
void	InternalizeArrayL(RArray< T > &, RReadStream &)
void	InternalizePointerArrayL(RPointerArray< T > &, RReadStream &)
TBool	IsAdornedVariationOfL(const TDesC &, const TDesC &)
	NONSHARABLE_CLASS(CObservationData)
	NONSHARABLE_CLASS(CObservationFilter)
	NONSHARABLE_CLASS(CObservationHeader)
	NONSHARABLE_CLASS(CProgressBarValuePublisher)
	NONSHARABLE_CLASS(CUninstalledPackageEntry)
	NONSHARABLE_CLASS(UninstalledSisPackages)
void	PanicClient(const RMessagePtr2 &, TInstallServerPanic)
TInt	ProgressBarChunkIncrement(TInt64)
TInt	ProgressBarFileIncrement(TInt64)
TUidType	SwiObserverImageFullUid()
TVersion	SwiObserverVersion()
	_LIT(KBinPath, "\\sys\\bin\\")
	_LIT(KControllerFileFilter, "*.ctl")
	_LIT(KControllerFileNameFormat, "%S%S%08x\\%08x_%04x.ctl")
	_LIT(KHashPath, "\\sys\\hash\\")
	_LIT(KHashPathFormat, "%c:%S")
	_LIT(KImportDir, "\\import\\")
	_LIT(KLogDir, "\\sys\\install\\log.txt")
	_LIT(KObserverFlagFileNameFormat, ":\\tmp\\%08xlog.flag")
	_LIT(KObserverLogDir, "log_obs\\")
	_LIT(KPreInstalledPath, "\\system\\install\\")
	_LIT(KPrivatePath, "\\private\\")
	_LIT(KPrivatePathFormat, "?:\\private\\")
	_LIT(KRegistryPath, "\\sys\\install\\sisregistry\\")
	_LIT(KResourcePath, "\\resource\\")
	_LIT(KSidCacheFileName, "sidcache.cache")
	_LIT(KSisHelperServerName, "!SISHELPER")
	_LIT(KSwiDaemonPrivateDirectory, "\\private\\10202dce\\")
	_LIT(KSwiLogDir, "log_swi\\")
	_LIT(KSwiObserverImageName, "swiobserver.exe")
	_LIT(KSwiObserverName, "!SwiObserver")
	_LIT(KSysInstallPath, "\\sys\\install\\integrityservices\\")
	_LIT(KSysInstallTempPath, "\\sys\\install\\temp\\")
	_LIT(KSysPath, "\\sys\\")
	_LIT(KUninstallLogPathFormat, "%c:\\sys\\uninstall\\%08x_%08x\\%c\\uninstall.log")
TExpressionResult	operator!(const TExpressionResult &)
TExpressionResult	operator!=(const TExpressionResult &, const TExpressionResult &)
TExpressionResult	operator<(const TExpressionResult &, const TExpressionResult &)
TExpressionResult	operator<=(const TExpressionResult &, const TExpressionResult &)
TExpressionResult	operator==(const TExpressionResult &, const TExpressionResult &)
TExpressionResult	operator>(const TExpressionResult &, const TExpressionResult &)
TExpressionResult	operator>=(const TExpressionResult &, const TExpressionResult &)

Member Attribute Documentation

FileNameUnadornedPartLength

const TInt

FileNameUnadornedPartLength

KAllowGrantUserCaps

const TLitC8< sizeof("AllowGrantUserCapabilities")>

KAllowGrantUserCaps

[static]

KAllowOrphanedOverwrite

const TLitC8< sizeof("AllowOrphanedOverwrite")>

KAllowOrphanedOverwrite

[static]

KAllowOverwriteOnRestore

const TLitC8< sizeof("AllowOverwriteOnRestore")>

KAllowOverwriteOnRestore

[static]

KAllowPackagePropagate

const TLitC8< sizeof("AllowPackagePropagate")>

KAllowPackagePropagate

[static]

KAllowProtectedOrphanOverwrite

const TLitC8< sizeof("AllowProtectedOrphanOverwrite")>

KAllowProtectedOrphanOverwrite

[static]

When true this flag allows orphaned files residing in private/xxxxxxxx/import, /resource or /sys/bin directories to be overwritten or eclipsed under user permission.

KAllowRunOnInstallUninstall

const TLitC8< sizeof("AllowRunOnInstallUninstall")>

KAllowRunOnInstallUninstall

[static]

KAllowUnsigned

const TLitC8< sizeof("AllowUnsigned")>

KAllowUnsigned

[static]

KAlternativeCodeSigningOid

const TLitC8< sizeof("AlternativeCodeSigningOID")>

KAlternativeCodeSigningOid

[static]

KApplicationShutdownTimeout

const TLitC8< sizeof("ApplicationShutdownTimeoutSeconds")>

KApplicationShutdownTimeout

[static]

KDRMEnabled

const TLitC8< sizeof("DRMEnabled")>

KDRMEnabled

[static]

KDRMIntent

const TLitC8< sizeof("DRMIntent")>

KDRMIntent

[static]

KDataField

const TUint8

KDataField

[static]

Indicates that the following line is in data format

KDeletePreinstalledFilesOnUninstall

const TLitC8< sizeof("DeletePreinstalledFilesOnUninstall")>

KDeletePreinstalledFilesOnUninstall

[static]

KHeaderField

const TUint8

KHeaderField

[static]

Indicates that the following line is in header format

KInstallServerImage

const TLitC< sizeof(L"InstallServer")/2 >

KInstallServerImage

[static]

KInstallServerName

const TLitC< sizeof(L"!InstallServer")/2 >

KInstallServerName

[static]

KInstallServerUid3

const TUid

KInstallServerUid3

KInstallServerVersionBuild

const TInt

KInstallServerVersionBuild

KInstallServerVersionMajor

const TInt

KInstallServerVersionMajor

The current version of the Install Server.

KInstallServerVersionMinor

const TInt

KInstallServerVersionMinor

KMandateCodeSigningExtension

const TLitC8< sizeof("MandateCodeSigningExtension")>

KMandateCodeSigningExtension

[static]

KMandatePolicies

const TLitC8< sizeof("MandatePolicies")>

KMandatePolicies

[static]

KMaxExpressionDepth

const TInt

KMaxExpressionDepth

[static]

Maximum recursion depth.

KMaxLogFileName

const TInt

KMaxLogFileName

[static]

Maximum length of a log file name.

KMaxNoOfDeletionAttempts

const TInt

KMaxNoOfDeletionAttempts

KMaxNumOfLogEntries

const TLitC8< sizeof("MaxNumOfLogEntries")>

KMaxNumOfLogEntries

[static]

KMaxUidCount

const TInt

KMaxUidCount

KOcspEnabled

const TLitC8< sizeof("OcspEnabled")>

KOcspEnabled

[static]

KOcspHttpHeaderFilter

const TLitC8< sizeof("OcspHttpHeaderFilter")>

KOcspHttpHeaderFilter

[static]

If defined in the ini file, this specifies the ECOM plugin which is used to filter the OCSP request HTTP headers.

KOcspMandatory

const TLitC8< sizeof("OcspMandatory")>

KOcspMandatory

[static]

KOid

const TLitC8< sizeof("Oid")>

KOid

[static]

KPhoneTsyName

const TLitC8< sizeof("PhoneTsyName")>

KPhoneTsyName

[static]

KProgressBarEndIncrement

const TInt

KProgressBarEndIncrement

[static]

The extra increment we add onto the end to make there always be some progress.

KProgressBarIncrement

const TInt

KProgressBarIncrement

[static]

Percentage of completion required before updating the progress bar.

KProgressBarInstallChunkSize

const TInt

KProgressBarInstallChunkSize

[static]

How many bytes to copy before updating the progress bar by one increment.

KProgressBarUninstallAmount

const TInt

KProgressBarUninstallAmount

[static]

How many increments to update the bar on the uninstall of a file.

KRemoveOnlyWithLastDependent

const TLitC8< sizeof("RemoveOnlyWithLastDependent")>

KRemoveOnlyWithLastDependent

[static]

When true this flag allows to delay the uninstallation of embedded packages until all their dependent packages have been uninstalled.

KReplacePath

const TLitC8< sizeof("ReplacePath")>

KReplacePath

[static]

KRetryInterval

const TInt

KRetryInterval

KRunWaitTimeout

const TLitC8< sizeof("RunWaitTimeoutSeconds")>

KRunWaitTimeout

[static]

KSISCompatibleIfNoTargetDevices

const TLitC8< sizeof("SISCompatibleIfNoTargetDevices")>

KSISCompatibleIfNoTargetDevices

[static]

KSWIObserverRetryDelay

const TInt

KSWIObserverRetryDelay

[static]

Delay in microseconds before the client re-tries to connect to the SWI Observer.

KSisHelperServerUid3

const TUid

KSisHelperServerUid3

KSisHelperVersionBuild

const TInt

KSisHelperVersionBuild

KSisHelperVersionMajor

const TInt

KSisHelperVersionMajor

KSisHelperVersionMinor

const TInt

KSisHelperVersionMinor

KSwiObserverShutdownPeriod

const TInt

KSwiObserverShutdownPeriod

Delay in microseconds before the SWI Observer is shut down, after the last remaining session has been closed.

KSwiObserverVerBuild

const TInt

KSwiObserverVerBuild

SWI Observer version build component.

KSwiObserverVerMajor

const TInt

KSwiObserverVerMajor

SWI Observer version major component.

KSwiObserverVerMinor

const TInt

KSwiObserverVerMinor

SWI Observer version minor component.

KSwisOperationMask

const TUint

KSwisOperationMask

Software install operation mask - 0xFF.

KSwisOperationStatusMask

const TUint

KSwisOperationStatusMask

Software install operation status mask - 0xFF00.

KSwisPolicyFile

const TLitC< sizeof(L"z:\\system\\data\\swipolicy.ini")/2 >

KSwisPolicyFile

[static]

KUidSoftwareInstallKey

const TUint

KUidSoftwareInstallKey

This key and values that follow are now aliased to those defined in the header base header SaCls.h. This is necessary so Core OS components can still be dependent on software install. DO NOT change the assigned values here, update sacls.h for aliased definitions.

KUidSwiObserver

const TUid

KUidSwiObserver

Hosting the executable's secure ID. Required to launch the process.

KUserCapabilities

const TLitC8< sizeof("UserCapabilities")>

KUserCapabilities

[static]

KVariableLanguage

const TInt

KVariableLanguage

[static]

KVariableRemoteInstall

const TInt

KVariableRemoteInstall

[static]

Member Enumeration Documentation

Enum StateMachinePanic

Panic ID for panics raised in state machine

Enumerator	Value	Description
EStateError

Enum TDevCertWarningState

Enumerator	Value	Description
ENoDevCerts	0
EFoundDevCerts	1
EDevCertsWarned	2

Enum TErrorDialog

Software Install error dialog type for SISX files.

Enum TFileFlag

Describes various information about a file which has been written into the log file as a record.

Enumerator	Value	Description
EFileAdded	0x01	The file was copied to the system.
EFileDeleted	0x02	The file was deleted from the system.
EFileDll	0x10	The file is a DLL.
EFileExe	0x20	The file is an EXE.

Enum TFileTextOption

Text file display options. This controls which type of dialog appears when using MUiHandler::DisplayTextL().

Enum TFlagFileOperation

A flag file whose presence indicates to the client that there are logfiles left in the observer's private dir, so the client have to start the observer to get the files processed.

Enumerator	Value	Description
EDeleteFlagFile
ECreateFlagFile

Enum TInstallCancellableEvent

Software Install event types which can be cancelled.

See also: MUiHandler::HandleInstallCancellableEventL()

Enumerator	Value	Description
EEventRemovingFiles		Files are being removed.
EEventShuttingDownApps		Some applications are being shut down.
EEventCopyingFiles		Files are being copied.
EEventOcspCheckStart		Certificate status check is being carried out.

Enum TInstallEvent

Software Install event type.

See also: MUiHandler::HandleInstallEventL()

Note: EEventAbortedInstall and EEventAbortedUnInstall are now considered as superfluous and are no longer generated. The application knows when it requests a cancel, and knows the cancel is complete when either the synchronous Launcher call returns or the asynchronous CAsyncLauncher request completes.

Enumerator	Value	Description
EEventSetProgressBarFinalValue		Gives the final value for the progress bar.
EEventUpdateProgressBar		The progress bar must be updated.
EEventAbortedInstall		The installation has been aborted - NOT generated.
EEventCompletedInstall		The installation has been completed.
EEventCompletedUnInstall		The uninstallation has been completed.
EEventAbortedUnInstall		The uninstallation has been aborted - NOT generated.
EEventCompletedNoMessage		The operation has been completed.
EEventLeave		An error has occurred: a function issued a "leave".
EEventOcspCheckEnd		The certificate revocation check has been completed.
EEventDevCert		The installed application is signed by devcert.

Enum TInstallServerMessage

Messages Launcher sends to SWIS

Enumerator	Value	Description
EInstall
EUninstall
ECancel
ERestore
ERestoreFile
ERestoreCommit
EListUnInstalledPkgs
ERemoveUnInstalledPkg

Enum TInstallServerPanic

A bad client is panicked by SWIS with these codes

Enumerator	Value	Description
EPanicInstallServerBadDescriptor
EPanicInstallServerIllegalFunction

Enum TIntegrityServicesEvent

Defines the events recorded in the journal file

Enumerator	Value	Description
ENone
ERemovedFile
EBackupFile
ETempFile
EAddedFile
EInstallComplete
EBackupFilesRemoved
EAddedFilesRemoved
ERemovedFilesRestored
ETempFilesRemoved

Enum TOperationType

A set of enumerated values is used to identify which SWI operation is in progress.

Enumerator	Value	Description
EOpInstall	0
EOpUninstall
EOpRestore

Enum TPackageType

A set of enumerated values which is used to indicate the type of the package which has influenced from the current SWI operation.

Enumerator	Value	Description
EStandardApplication	0
EStandardPatch
EPartialUpgrade
EPreinstalledApplication
EPreinstalledPatch
EUnknownPackage

Enum TQuestionDialog

Software Install generic question type.

Enumerator	Value	Description
EQuestionIncompatible		Ask whether to install an incompatible installation on the device.
EQuestionOverwriteFile		Ask whether to overwrite a file, which is not part of any package installation. The descriptor parameter contains the name of the file which is being overwritten.

Enum TRestoreFileMessage

Restore file messages pass parameters in these message slots

Enumerator	Value	Description
EMessageSlotRestoreFs
EMessageSlotRestoreFile
EMessageSlotRestorePath

Enum TRestoreMessage

Restore messages pass parameters in these message slots

Enumerator	Value	Description
EMessageSlotRestoreUid
EMessageSlotRestoreController

Enum TRevocationDialogMessage

Message type for the revocation check result dialog.

See also: MUiHandler::DisplayRevocationL()

Enumerator	Value	Description
EInvalidRevocationServerUrl		The OCSP server URL provided is invalid.
EUnableToObtainCertificateStatus		It is not possible to obtain the certificate status.
EResponseSignatureValidationFailure		It was not possible to validate the OCSP server response signature.
EInvalidRevocationServerResponse		The OCSP server reply is invalid.
EInvalidCertificateStatusInformation		The certificate status information is invalid.
ECertificateStatusIsUnknown		The certificate status is unknown.
ECertificateStatusIsUnknownSelfSigned		The certificate status is unknown, but this is expected for self-signed.
ECertificateStatusIsRevoked		The certificate has been revoked.

Enum TRevocationStatus

An enumeration providing information regarding the certificate revocation status of a controller. The order of the members is important and should not be changed as it is relied on elsewhere.

Enumerator	Value	Description
EUnknown2	0	The revocation status is unknown, the associated registry entry has been populated from an old database
EOcspNotPerformed	10	OCSP revocation check not performed due to user decision or failed validation
EOcspRevoked	20	1 or more required certificate(s) were revoked.
EOcspUnknown	30	1 or more certificates were 'unknown' to the OCSP server
EOcspTransient	40	1 or more checks resulted in transient error
EOcspGood	50	All certificate chains good

Enum TSignatureValidationResult

Software Install signature validation result.

See also: MUiHandler::DisplaySecurityWarningL()

Enumerator	Value	Description
EValidationSucceeded		The signature has been validated successfully.
ESignatureSelfSigned		The signature validates correctly, but chains back to a self-signed root.
ENoCertificate		Cannot find the certificate.
ECertificateValidationError		An error has occurred during signature validation.
ESignatureNotPresent		There is no signature to verify.
ESignatureCouldNotBeValidated		The signature could not be validated.
ENoCodeSigningExtension		The certificate is not trusted for code signing usage.
ENoSupportedPolicyExtension		Cannot find the certificate policies.
EMandatorySignatureMissing		A signature resolving to one of the mandatory certificate cannot be found.

Enum TSisHelperMessage

SISHelper server messages

Enumerator	Value	Description
ESisHelperGetController		Retrieve SISController.
ESisHelperExtractFile		Copy / decompress a file.
ESisHelperFillDrivesAndSpaces		Return available disk drives and spaces.
ESisHelperOpenDrmContent		Evaluate the intent for this installation.
ESisHelperExecuteDrmIntent		Execute the intent for this installation.
ESisHelperSetupAsyncExtraction		Begin copy / decompress part of a file.
ESisHelperAsyncExtraction		Continue copy / decompress part of a file.
ESisHelperEndAsyncExtraction		End copy / decompress part of a file.
ESisHelperCreateSisStub		Create a .SIS stub file.
ESisHelperIsStub		Query whether the SIS file contains any data, if not it's a stub (preinstalled).
ESisHelperGetSisFileDrive		Find the drive letter the SIS is installed from. (-1) if unknown.
ESisHelperIsSisFileReadOnly		Check if the SIS file is read only (affects whether to delete on uninstall of preinstalled package.).
ESisHelperGetSisFileName		Get name with path of SIS file.
ESisHelperGetControllerFromSis		Retrieve SISController from the specified SISX file.
ESisHelperGetEquivalentLanguages		Retrieve fetching equivalent languages.

Enum TSisHelperPanic

Panic code for panicking a badly written client

Enumerator	Value	Description
EPanicBadDescriptor
EPanicIllegalFunction
EPanicAlreadyReceiving
EPanicBadStartupDataType		Unknown startup data type (see TSisHelperStartParams::TType)
EPanicBadDataProvider		Bad interface pointer passed in startup data

Enum TSisPackageTrust

Enumerator	Value	Description
ESisPackageUnsignedOrSelfSigned	0	Untrusted - Application is unsigned or self-signed.
ESisPackageValidationFailed	50	Untrusted - Application's Certificate chain validation failed.
ESisPackageCertificateChainNoTrustAnchor	100	Untrusted - Application's Certificate chain validated but no matching issuer certificate could be found in the certstore.
ESisPackageCertificateChainValidatedToTrustAnchor	200	Trusted - Application's Certificate chain validated to an issuer certificate in the certstore.
ESisPackageChainValidatedToTrustAnchorOCSPTransientError	300	Trusted - Application's Certificate chain validated and OCSP failed with a transient error.
ESisPackageChainValidatedToTrustAnchorAndOCSPValid	400	Trusted - Application's Certificate chain validated and OCSP response was ok.
ESisPackageBuiltIntoRom	500	Trusted - Application is built into device ROM.

Enum TSwiLogTypes

Enumerator	Value	Description
ESwiLogInstall	0
ESwiLogUnInstall
ESwiLogUpgrade
ESwiLogRestore

Enum TSwiObserverFunction

Functions supported by a SWI Observer session.

Enumerator	Value	Description
ERegisterToObserver	0	Registers to the SWI Observer.
ETransferFileHandle		Transfer the observation file handle.
ESwiCommit		Start processing the observation file.

Enum TSwisOperation

Software install operations states.

Enumerator	Value	Description
ESwisNone	ESASwisNone	0x00 No operation
ESwisInstall	ESASwisInstall	0x01 Swis install operation is in progress
ESwisUninstall	ESASwisUninstall	0x02 Swis uninstall operation is in progress
ESwisRestore	ESASwisRestore	0x04 Swis restore operation is in progress

Enum TSwisOperationStatus

Software Install operation status value.

Enumerator	Value	Description
ESwisStatusNone	ESASwisStatusNone	0x0000 The current operation is in progress
ESwisStatusSuccess	ESASwisStatusSuccess	0x0100 The current/last operation succeeded
ESwisStatusAborted	ESASwisStatusAborted	0x0200 The current/last operation failed

Enum TValidationStatus

An enumeration providing information regarding the certificate validation status of a controller. The order of the members is important and should not be changed as it is relied on elsewhere.

Enumerator	Value	Description
EUnknown	0	The validation status is unknown, the associated registry entry has been populated from an old database
EExpired	10	Signed and validated at install time but one or more required certificate chains was expired at the time of a subsequent revocation check
EInvalid	20	The validation status is invalid All required certificate chains failed validation
EUnsigned	30	Application is unsigned, no certificates
EValidated	40	1 or more required chains validated but none to a matching issuer certificate in the certstore
EValidatedToAnchor	50	1 or more certificate chains validated to an issuer certificate in the certstore
EPackageInRom	60	Package was installed in ROM

Member Function Documentation

CopyArrayL ( RArray< T > &, const RArray< T > & )

void	CopyArrayL	(	RArray< T > &	aNew,
			const RArray< T > &	aOld
		)

CopyPointerArrayL ( RPointerArray< T > &, const RPointerArray< T > & )

void	CopyPointerArrayL	(	RPointerArray< T > &	aNew,
			const RPointerArray< T > &	aOld
		)

ExternalizeArrayL ( const RArray< T > &, RWriteStream & )

void	ExternalizeArrayL	(	const RArray< T > &	aArray,
			RWriteStream &	aStream
		)

ExternalizePointerArrayL ( const RPointerArray< T > &, RWriteStream & )

void	ExternalizePointerArrayL	(	const RPointerArray< T > &	aArray,
			RWriteStream &	aStream
		)

FindAllAdornedVariantsL ( RFs &, const TDesC &, const TDesC &, RPointerArray< HBufC > & )

void	FindAllAdornedVariantsL	(	RFs &	aFs,
			const TDesC &	aSearchNameWild,
			const TDesC &	aSearchPath,
			RPointerArray< HBufC > &	aAdornedFileNamesFound
		)

Searches through the file system looking for all variants of searchNameWild

Parameter	Description
aFs	handle to a fileserver session
aSearchNameWild	represents the filename pattern that is to be searched for (i.e: afile{????????}.ext)
aSearchPath	represents the path to be searched through on all drives (i.e: \)
aAdornedFileNamesFound	all files matching the pattern are returned in this array (contains fully qualified filenames i.e. full path+name+ext)

GenerateSearchNameWildL ( const TDesC &, TDes & )

void	GenerateSearchNameWildL	(	const TDesC &	aFileName,
			TDes &	aSearchNameWild
		)

Generates adorned filename pattern using wild chars for searching

Parameter	Description
aFileName	the filename that is the base of the pattern; can be either unadorned or adorned name (i.e: somename.ext or somename{12345678}.ext)
aSearchNameWild	the calculated pattern output (i.e: somename{????????}.ext)

GetAllUids ( RArray< TUid > & )

IMPORT_C TInt

GetAllUids

(

RArray< TUid > &

aUidList

)

Returns an array of package Uids published by the installer.

Parameter	Description
aUidList	Array which holds a list of Uids that is published.

Returns: KErrNone in case of success otherwise one of the system-wide error codes.

GetUnadornedFileName ( const TDesC &, TDes & )

void	GetUnadornedFileName	(	const TDesC &	aAdornedFilename,
			TDes &	aUnadornedFilename
		)

Checks if the input filename is adorned and cuts off the adorned part

Parameter	Description
aAdornedFilename	buffer containing the input filename (possibly adorned)

InternalizeArrayL ( RArray< T > &, RReadStream & )

void	InternalizeArrayL	(	RArray< T > &	aArray,
			RReadStream &	aStream
		)

InternalizePointerArrayL ( RPointerArray< T > &, RReadStream & )

void	InternalizePointerArrayL	(	RPointerArray< T > &	aArray,
			RReadStream &	aStream
		)

IsAdornedVariationOfL ( const TDesC &, const TDesC & )

TBool	IsAdornedVariationOfL	(	const TDesC &	aFileName1,
			const TDesC &	aFileName2
		)

Checks if the two input filenames are variants of each other (belong to the same adorned name "family")

Parameter	Description
aFileName1	first name to compare (full path and name)
aFileName2	second name to compare (full path and name)

NONSHARABLE_CLASS ( CObservationData )

NONSHARABLE_CLASS

(

CObservationData

)

Class for a single observation record data. Contains the basic information about a changed file by the SWI operation. Each observed SWI event in an observation log corresponds to a single observation data.

NONSHARABLE_CLASS ( CObservationFilter )

NONSHARABLE_CLASS

(

CObservationFilter

)

Class that represents a filter list which is used to filter SWI observation. SWI Observer ECOM plug-in implementations declares the folders in which they are intrested by using this class.

NONSHARABLE_CLASS ( CObservationHeader )

NONSHARABLE_CLASS

(

CObservationHeader

)

Class that contains all observation records related with a specific package. In an observation log file, each header info corresponds to a specific package.

NONSHARABLE_CLASS ( CProgressBarValuePublisher )

NONSHARABLE_CLASS

(

CProgressBarValuePublisher

)

This class is used to publish the percentage value of the installation progress bar. The progress bar value is published by using a publish&subscribe property.

See also: Swi::KUidSwiProgressBarValueKey.

NONSHARABLE_CLASS ( CUninstalledPackageEntry )

NONSHARABLE_CLASS

(

CUninstalledPackageEntry

)

Uninstalled application entry class.

This class is not externally instantiable. It is returned as a result of querying for a list of uninstalled packages present on a removable drive. Each object of this type represents one uninstalled package. Methods can be called on this object to retrieve the package details such as Package UID, Name, Vendor, Version and Type.

NONSHARABLE_CLASS ( UninstalledSisPackages )

NONSHARABLE_CLASS

(

UninstalledSisPackages

)

This class provides static methods for managing uninstalled native packages (SIS files) that are taking up space on removable drives.

PanicClient ( const RMessagePtr2 &, TInstallServerPanic )

void	PanicClient	(	const RMessagePtr2 &	aMessage,
			TInstallServerPanic	aPanic
		)	[static]

Local function to panic an offending client

ProgressBarChunkIncrement ( TInt64 )

TInt

ProgressBarChunkIncrement

(

TInt64

aSize

)

[inline]

Utility function to get how much to update the progress bar for a certain size of chunk copied.

ProgressBarFileIncrement ( TInt64 )

TInt

ProgressBarFileIncrement

(

TInt64

aSize

)

[inline]

Utility function to get how much to update the progress bar for a certain size of file copied. The smallest increment is KProgressBarEndIncrement since we always want to show that some progress has occurred.

SwiObserverImageFullUid ( )

TUidType

SwiObserverImageFullUid

(

)

[inline]

This function is defined because there is no literal constructor for TUidType. It returns the SWI Observer executable's UID, which is used to ensure the client side code launches the correct server process, as opposed to another application which uses the same executable name.

Returns: TUidType The SWI Observer executable's full UID.

SwiObserverVersion ( )

TVersion

SwiObserverVersion

(

)

[inline]

This function is defined because there is no literal constructor for TVersion.

Returns: Defines a version number which the client side code can use to open the SWI Obserevr. If the client code was built with a higher version number, then it cannot open the SWI Observer. This ensures that a client only talks to the SWI Observer version is at least as high as its own.

_LIT ( KBinPath, "\\sys\\bin\\" )

_LIT	(	KBinPath	,
		"\\sys\\bin\\"
	)

_LIT ( KControllerFileFilter, "*.ctl" )

_LIT	(	KControllerFileFilter	,
		"*.ctl"
	)

_LIT ( KControllerFileNameFormat, "%S%S%08x\\%08x_%04x.ctl" )

_LIT	(	KControllerFileNameFormat	,
		"%S%S%08x\\%08x_%04x.ctl"
	)

_LIT ( KHashPath, "\\sys\\hash\\" )

_LIT	(	KHashPath	,
		"\\sys\\hash\\"
	)

_LIT ( KHashPathFormat, "%c:%S" )

_LIT	(	KHashPathFormat	,
		"%c:%S"
	)

_LIT ( KImportDir, "\\import\\" )

_LIT	(	KImportDir	,
		"\\import\\"
	)

_LIT ( KLogDir, "\\sys\\install\\log.txt" )

_LIT	(	KLogDir	,
		"\\sys\\install\\log.txt"
	)

_LIT ( KObserverFlagFileNameFormat, ":\\tmp\\%08xlog.flag" )

_LIT	(	KObserverFlagFileNameFormat	,
		":\\tmp\\%08xlog.flag"
	)

_LIT ( KObserverLogDir, "log_obs\\" )

_LIT	(	KObserverLogDir	,
		"log_obs\\"
	)

A log file in this directory, when it is being processed.

_LIT ( KPreInstalledPath, "\\system\\install\\" )

_LIT	(	KPreInstalledPath	,
		"\\system\\install\\"
	)

_LIT ( KPrivatePath, "\\private\\" )

_LIT	(	KPrivatePath	,
		"\\private\\"
	)

_LIT ( KPrivatePathFormat, "?:\\private\\" )

_LIT	(	KPrivatePathFormat	,
		"?:\\private\\"
	)

_LIT ( KRegistryPath, "\\sys\\install\\sisregistry\\" )

_LIT	(	KRegistryPath	,
		"\\sys\\install\\sisregistry\\"
	)

_LIT ( KResourcePath, "\\resource\\" )

_LIT	(	KResourcePath	,
		"\\resource\\"
	)

_LIT ( KSidCacheFileName, "sidcache.cache" )

_LIT	(	KSidCacheFileName	,
		"sidcache.cache"
	)

_LIT ( KSisHelperServerName, "!SISHELPER" )

_LIT	(	KSisHelperServerName	,
		"!SISHELPER"
	)

_LIT ( KSwiDaemonPrivateDirectory, "\\private\\10202dce\\" )

_LIT	(	KSwiDaemonPrivateDirectory	,
		"\\private\\10202dce\\"
	)

_LIT ( KSwiLogDir, "log_swi\\" )

_LIT	(	KSwiLogDir	,
		"log_swi\\"
	)

A log file in this directory, if it has not started to be processed yet.

_LIT ( KSwiObserverImageName, "swiobserver.exe" )

_LIT	(	KSwiObserverImageName	,
		"swiobserver.exe"
	)

Executable which hosts SWI Observer. Required to launch the process.

_LIT ( KSwiObserverName, "!SwiObserver" )

_LIT	(	KSwiObserverName	,
		"!SwiObserver"
	)

Identifies SWI Observer Symbian OS server.

_LIT ( KSysInstallPath, "\\sys\\install\\integrityservices\\" )

_LIT	(	KSysInstallPath	,
		"\\sys\\install\\integrityservices\\"
	)

_LIT ( KSysInstallTempPath, "\\sys\\install\\temp\\" )

_LIT	(	KSysInstallTempPath	,
		"\\sys\\install\\temp\\"
	)

_LIT ( KSysPath, "\\sys\\" )

_LIT	(	KSysPath	,
		"\\sys\\"
	)

_LIT ( KUninstallLogPathFormat, "%c:\\sys\\uninstall\\%08x_%08x\\%c\\uninstall.log" )

_LIT	(	KUninstallLogPathFormat	,
		"%c:\\sys\\uninstall\\%08x_%08x\\%c\\uninstall.log"
	)

operator! ( const TExpressionResult & )

TExpressionResult

operator!

(

const TExpressionResult &

aExpression

)

[inline]

operator!= ( const TExpressionResult &, const TExpressionResult & )

TExpressionResult	operator!=	(	const TExpressionResult &	aLhs,
			const TExpressionResult &	aRhs
		)	[inline]

operator< ( const TExpressionResult &, const TExpressionResult & )

TExpressionResult	operator<	(	const TExpressionResult &	aLhs,
			const TExpressionResult &	aRhs
		)	[inline]

operator<= ( const TExpressionResult &, const TExpressionResult & )

TExpressionResult	operator<=	(	const TExpressionResult &	aLhs,
			const TExpressionResult &	aRhs
		)	[inline]

operator== ( const TExpressionResult &, const TExpressionResult & )

TExpressionResult	operator==	(	const TExpressionResult &	aLhs,
			const TExpressionResult &	aRhs
		)	[inline]

operator> ( const TExpressionResult &, const TExpressionResult & )

TExpressionResult	operator>	(	const TExpressionResult &	aLhs,
			const TExpressionResult &	aRhs
		)	[inline]

operator>= ( const TExpressionResult &, const TExpressionResult & )

TExpressionResult	operator>=	(	const TExpressionResult &	aLhs,
			const TExpressionResult &	aRhs
		)	[inline]

Enumerator	Value	Description
EUiAlreadyInRom		Cannot overwrite ROM component.
EUiMissingDependency		Missing a dependency.
EUiRequireVer		A dependency exists on a specific version of an application which is different from the one installed.
EUiRequireVerOrGreater		A dependency requires a version of an application which is greater than the one installed. */.
EUiFileCorrupt		SISX file corrupt, checksums stored in file do not match actual.
EUiDiskNotPresent		A removable media drive had no media while trying to access it.
EUiCannotRead		We cannot read a file which is needed for us to proceed.
EUiCannotDelete		We are forbidden to delete a certain file.
EUiInvalidFileName		A filename given inside the SISX package is not valid.
EUiFileNotFound		A file needed to proceed cannot be found.
EUiInsufficientSpaceOnDrive		There was insufficient space left on the drive to perform an operation.
EUiCapabilitiesCannotBeGranted		The applications requires system capability it is not signed for.
EUiUnknownFile		File to install is not a recognized SISX file.
EUiMissingBasePackage		A base package was missing when installing an augmentation or a partial upgrade, the descriptor parameter contains a TPckg<TUid> with the uid of the missing application, which will be the same as the uid of the package being installed.
EUiConstraintsExceeded		Constraints imposed by a developer mode certificate have been exceeded.
EUiSIDViolation		The package contains a file with a protected SID which is not signed for.
EUiVIDViolation		The package contains a file with a protected VID which is not signed for.
EUiNoMemoryInDrive
EUiUIDPackageViolation		< No enough space in the selected drive to install the package. The package uid is protected but not signed for.
EUiOSExeViolation		The package contains an invalid eclipsing EXE that would eclipse an exe in ROM.
EUiSIDMismatch
EUiBlockingEclipsingFile		< Application SID doesnt match with existing SID in private Directory.

Enumerator	Value	Description
EInstFileTextOptionContinue	0	It is recommended that the UI displays a dialog containing a Continue button. On exiting the dialog, installation continues regardless of the dialog's return value.
EInstFileTextOptionSkipOneIfNo		It is recommended that the UI displays a dialog containing Yes/No buttons. The software installer skips installing the next file if the dialog returns false (user pressed No). It will install the next file if the dialog returns true (user pressed Yes).
EInstFileTextOptionAbortIfNo		It is recommended that the UI displays a dialog containing Yes/No buttons. The software installer continues with the installation if the dialog returns true (user pressed Yes). It will abort the installation if the dialog returns false (user pressed No).
EInstFileTextOptionExitIfNo		Same as EInstFileTextOptionAbortIfNo.
EInstFileTextOptionForceAbort		It is recommended that UI display a TextContinue dialog.On exiting the dialog , installation must abort regardless of the dialog's return value.