RApaLsSession Class Reference

class RApaLsSession : public RSessionBase

A session with the application architecture server.

The server provides access to a cached list of the applications on the device.

To use this class, clients first need to connect to the server.

Then, one of GetAllApps(), GetEmbeddableApps() or GetFilteredApps() needs to be called. These functions do some initialisation of server data in preparation for returning the application list (which is owned by the server).

Then, GetNextApp() is called in a loop. The first time around, it populates the session's application list and retrieves the first application in the list. Further calls to GetNextApp() retrieve the remaining applications in the list, until RApaLsSession::ENoMoreAppsInList is returned.

The session should be closed when it is no longer needed, before it goes out of scope.

Various functions in RApaLsSession need to access the application list, and may return RApaLsSession::EAppListInvalid to indicate that the function was called before the initial population of the list is complete. If this occurs, you could try again after a short delay.

This class provides many other functions, for instance launching applications, querying application-specific information, recognising data.

Inherits from

Public Member Functions
RApaLsSession()
IMPORT_C TIntAppCount(TInt &)
IMPORT_C TIntAppForDataType(const TDataType &, TUid &)
IMPORT_C TIntAppForDataTypeAndService(const TDataType &, TUid, TUid &)
IMPORT_C TIntAppForDocument(const TDesC &, TUid &, TDataType &)
IMPORT_C TIntAppForDocument(const RFile &, TUid &, TDataType &)
IMPORT_C TIntAppForDocumentAndService(const TDesC &, TUid, TUid &, TDataType &)
IMPORT_C TIntAppForDocumentAndService(const RFile &, TUid, TUid &, TDataType &)
IMPORT_C TIntApplicationLanguage(TUid, TLanguage &)
IMPORT_C TIntCancelListPopulationCompleteObserver()
IMPORT_C voidCancelNotify()
IMPORT_C voidCancelNotifyOnDataMappingChange()
IMPORT_C voidCancelRecognizeFiles()
IMPORT_C voidClearFsSession()
IMPORT_C voidClose()
IMPORT_C voidCommitNonNativeApplicationsUpdatesL()
IMPORT_C TIntConnect()
IMPORT_C TIntCreateDocument(const TDesC &, TUid, TThreadId &, TLaunchType)
IMPORT_C TIntDeleteDataMapping(const TDataType &)
IMPORT_C TIntDeleteDataMapping(const TDataType &, TUid)
IMPORT_C voidDeregisterNonNativeApplicationL(TUid)
IMPORT_C voidDeregisterNonNativeApplicationTypeL(TUid)
IMPORT_C TIntEmbeddableAppCount(TInt &)
IMPORT_C voidForceCommitNonNativeApplicationsUpdatesL()
IMPORT_C TIntForceRegistration(const RPointerArray< TDesC > &)
IMPORT_C RFs *FsSession()
IMPORT_C TIntGetAcceptedConfidence(TInt &)
IMPORT_C TIntGetAllApps()
IMPORT_C TIntGetAllApps(TInt)
IMPORT_C TIntGetAppByDataType(const TDataType &, TUid, TUid &)
IMPORT_C TIntGetAppCapability(TDes8 &, TUid)
IMPORT_C TIntGetAppIcon(TUid, TInt, CApaMaskedBitmap &)
IMPORT_C TIntGetAppIcon(TUid, TSize, CApaMaskedBitmap &)
IMPORT_C TIntGetAppIcon(TUid, HBufC *&)
IMPORT_C TIntGetAppIcon(TUid, RFile &)
IMPORT_C TIntGetAppIconSizes(TUid, CArrayFixFlat< TSize > &)
IMPORT_C TIntGetAppInfo(TApaAppInfo &, TUid)
IMPORT_C TIntGetAppOwnedFiles(CDesCArray &, TUid)
IMPORT_C CApaAppServiceInfoArray *GetAppServiceOpaqueDataLC(TUid, TUid)
IMPORT_C voidGetAppServicesL(TUid, CArrayFixFlat< TUid > &)
IMPORT_C CApaAppServiceInfoArray *GetAppServicesLC(TUid)
IMPORT_C TIntGetAppType(TUid &, TUid)
IMPORT_C TIntGetAppViewIcon(TUid, TUid, const TSize &, CApaMaskedBitmap &)
IMPORT_C TIntGetAppViewIcon(TUid, TUid, HBufC *&)
IMPORT_C TIntGetAppViews(CApaAppViewArray &, TUid)
IMPORT_C TIntGetDefaultScreenNumber(TInt &, TUid)
IMPORT_C TIntGetEmbeddableApps()
IMPORT_C TIntGetEmbeddableApps(TInt)
IMPORT_C TIntGetFilteredApps(const TApaEmbeddabilityFilter &)
IMPORT_C TIntGetFilteredApps(const TApaEmbeddabilityFilter &, TInt)
IMPORT_C TIntGetFilteredApps(TUint, TUint)
IMPORT_C TIntGetFilteredApps(TUint, TUint, TInt)
IMPORT_C TIntGetMaxDataBufSize(TInt &)
IMPORT_C TIntGetNextApp(TApaAppInfo &)
IMPORT_C TIntGetNextApp(TApaAppInfo &, TInt)
IMPORT_C TIntGetPreferredBufSize(TInt &)
IMPORT_C TIntGetServerApps(TUid)
IMPORT_C TIntGetServerApps(TUid, TInt)
IMPORT_C CApaAppServiceInfoArray *GetServiceImplementationsLC(TUid)
IMPORT_C CApaAppServiceInfoArray *GetServiceImplementationsLC(TUid, const TDataType &)
IMPORT_C TIntGetSupportedDataTypesL(CDataTypeArray &)
IMPORT_C TIntInsertDataMapping(const TDataType &, TDataTypePriority, TUid)
IMPORT_C TIntInsertDataMapping(const TDataType &, TDataTypePriority, TUid, TUid)
IMPORT_C TIntInsertDataMappingIfHigher(const TDataType &, TDataTypePriority, TUid, TBool &)
IMPORT_C TIntIsProgram(const TDesC &, TBool &)
IMPORT_C TIntMatchesSecurityPolicy(TBool &, TUid, const TSecurityPolicy &)
IMPORT_C voidNotifyOnDataMappingChange(TRequestStatus &)
IMPORT_C TIntNumberOfOwnDefinedIcons(TUid, TInt &)
IMPORT_C voidPrepareNonNativeApplicationsUpdatesL()
IMPORT_C TIntRecognizeData(const TDesC8 &, TDataRecognitionResult &)
IMPORT_C TIntRecognizeData(const TDesC &, const TDesC8 &, TDataRecognitionResult &)
IMPORT_C TIntRecognizeData(const RFile &, TDataRecognitionResult &)
IMPORT_C TIntRecognizeFilesL(const TDesC &, CDataRecognitionResultArray &)
IMPORT_C voidRecognizeFilesL(const TDesC &, CDataRecognitionResultArray &, TRequestStatus &)
IMPORT_C TIntRecognizeFilesL(const TDesC &, const TDesC8 &, CDataRecognitionResultArray &)
IMPORT_C voidRecognizeFilesL(const TDesC &, const TDesC8 &, CDataRecognitionResultArray &, TRequestStatus &)
IMPORT_C TIntRecognizeSpecificData(const TDesC &, const TDesC8 &, const TDataType &, TBool &)
IMPORT_C TIntRecognizeSpecificData(const RFile &, const TDataType &, TBool &)
IMPORT_C voidRegisterListPopulationCompleteObserver(TRequestStatus &)
IMPORT_C voidRegisterNonNativeApplicationL(TUid, const TDriveUnit &, CApaRegistrationResourceFileWriter &, CApaLocalisableResourceFileWriter *, const RFile *)
IMPORT_C voidRegisterNonNativeApplicationTypeL(TUid, const TDesC &)
IMPORT_C TIntRollbackNonNativeApplicationsUpdates()
IMPORT_C TIntSetAcceptedConfidence(TInt)
IMPORT_C TIntSetAppShortCaption(const TDesC &, TLanguage, TUid)
IMPORT_C voidSetFsSessionL(RFs &)
IMPORT_C TIntSetMaxDataBufSize(TInt)
IMPORT_C voidSetNotify(TBool, TRequestStatus &)
IMPORT_C TIntStartApp(const CApaCommandLine &)
IMPORT_C TIntStartApp(const CApaCommandLine &, TThreadId &)
IMPORT_C TIntStartApp(const CApaCommandLine &, TThreadId &, TRequestStatus *)
IMPORT_C TIntStartDocument(const TDesC &, TThreadId &, TLaunchType)
IMPORT_C TIntStartDocument(const TDesC &, const TDataType &, TThreadId &, TLaunchType)
IMPORT_C TIntStartDocument(const TDesC &, TUid, TThreadId &, TLaunchType)
IMPORT_C TIntStartDocument(RFile &, TThreadId &, TRequestStatus *)
IMPORT_C TIntStartDocument(RFile &, const TDataType &, TThreadId &, TRequestStatus *)
IMPORT_C TIntStartDocument(RFile &, TUid, TThreadId &, TRequestStatus *)
IMPORT_C TVersionVersion()
Private Member Functions
voidCleanupOperation(TAny *)
CBufFlat *CreateRegFilesBufferL(const RPointerArray< TDesC > &)
voidDeletePointerToPointerToTAny(TAny *)
TInt DoAppCount(TInt &, TInt)
TInt DoAppForDocumentOptionallySpecifyingService(const TDesC &, TUid, TUid &, TDataType &, TInt)
TInt DoAppForDocumentOptionallySpecifyingService(const RFile &, TUid, TUid &, TDataType &, TInt)
voidDoGetAppIconSizesL(TUid, CArrayFixFlat< TSize > &)
voidDoGetAppOwnedFilesL(CDesCArray &, TUid)
voidDoGetAppViewsL(CApaAppViewArray &, TUid)
TInt DoStartApp(const CApaCommandLine &, TThreadId *, TRequestStatus *)
voidDoStartAppL(const CApaCommandLine &, TThreadId *, TRequestStatus *)
voidDoStartApplicationL(const TDesC &, const CApaCommandLine &, TThreadId &, TRequestStatus *)
voidFetchArrayL(MArrayFiller &, TUid, TInt, TInt)
TInt GetExecutableNameAndNewOpaqueData(TDes &, TDes &, HBufC8 *&, TIpcArgs &, TInt)
voidGetMainThreadIdL(TThreadId &, const RProcess &)
TInt GetNewBufferFromFile(HBufC8 *&, const TDesC &)
TInt GetNewOpaqueData(HBufC8 *&, TInt)
CBufBase *GetServiceBufferLC(TInt, TUid, TUid)
CBufBase *GetServiceBufferLC(TInt, TUid, const TDataType &)
IMPORT_C voidRApaLsSession_Reserved1()
IMPORT_C voidRApaLsSession_Reserved2()
TInt SendReceiveWithReconnect(TInt, const TIpcArgs &)
TInt StartApplicationPassingDocumentName(const TDesC &, const TDesC &, const TDesC8 *, const TDesC &, TThreadId &, TApaCommand, TRequestStatus *)
TInt StartApplicationPassingFileHandle(const TDesC &, const TDesC &, const TDesC8 *, const RFile &, TThreadId &, TRequestStatus *)
TInt TransferAndInternalizeDataL(const TDesC &, const TInt, CDataRecognitionResultArray &)
Inherited Functions
RHandleBase::Attributes()const
RHandleBase::BTraceId()const
RHandleBase::DoExtendedClose()
RHandleBase::Duplicate(const RThread &,TOwnerType)
RHandleBase::FullName()const
RHandleBase::FullName(TDes &)const
RHandleBase::Handle()const
RHandleBase::HandleInfo(THandleInfo *)
RHandleBase::Name()const
RHandleBase::NotifyDestruction(TRequestStatus &)
RHandleBase::Open(const TFindHandleBase &,TOwnerType)
RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
RHandleBase::RHandleBase()
RHandleBase::RHandleBase(TInt)
RHandleBase::SetHandle(TInt)
RHandleBase::SetHandleNC(TInt)
RSessionBase::CreateSession(RServer2,const TVersion &)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Open(TInt,TOwnerType)
RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Send(TInt)const
RSessionBase::Send(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt)const
RSessionBase::SendReceive(TInt,TRequestStatus &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
RSessionBase::SetReturnedHandle(TInt)
RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
RSessionBase::ShareAuto()
RSessionBase::ShareProtected()
Public Member Enumerations
enumTApaLsErrorCode { ENoMoreAppsInList = 1, EAppListInvalid }
enumTLaunchType { ELaunchNewApp = 1, ESwitchFiles }
Inherited Enumerations
RHandleBase:TAttributes
RSessionBase:TAttachMode
Private Attributes
CApaLsSessionExtension *iExtension
Inherited Attributes
RHandleBase::iHandle

Constructor & Destructor Documentation

RApaLsSession()

IMPORT_CRApaLsSession()

Member Functions Documentation

AppCount(TInt &)

IMPORT_C TIntAppCount(TInt &aCount)const

Parameters

TInt & aCount

AppForDataType(const TDataType &, TUid &)

IMPORT_C TIntAppForDataType(const TDataType &aDataType,
TUid &aAppUid
)const

Parameters

const TDataType & aDataType
TUid & aAppUid

AppForDataTypeAndService(const TDataType &, TUid, TUid &)

IMPORT_C TIntAppForDataTypeAndService(const TDataType &aDataType,
TUidaServiceUid,
TUid &aAppUid
)const

Parameters

const TDataType & aDataType
TUid aServiceUid
TUid & aAppUid

AppForDocument(const TDesC &, TUid &, TDataType &)

IMPORT_C TIntAppForDocument(const TDesC &aFileName,
TUid &aAppUid,
TDataType &aDataType
)const

Parameters

const TDesC & aFileName
TUid & aAppUid
TDataType & aDataType

AppForDocument(const RFile &, TUid &, TDataType &)

IMPORT_C TIntAppForDocument(const RFile &aFile,
TUid &aAppUid,
TDataType &aDataType
)const

Parameters

const RFile & aFile
TUid & aAppUid
TDataType & aDataType

AppForDocumentAndService(const TDesC &, TUid, TUid &, TDataType &)

IMPORT_C TIntAppForDocumentAndService(const TDesC &aFileName,
TUidaServiceUid,
TUid &aAppUid,
TDataType &aDataType
)const

Parameters

const TDesC & aFileName
TUid aServiceUid
TUid & aAppUid
TDataType & aDataType

AppForDocumentAndService(const RFile &, TUid, TUid &, TDataType &)

IMPORT_C TIntAppForDocumentAndService(const RFile &aFile,
TUidaServiceUid,
TUid &aAppUid,
TDataType &aDataType
)const

Parameters

const RFile & aFile
TUid aServiceUid
TUid & aAppUid
TDataType & aDataType

ApplicationLanguage(TUid, TLanguage &)

IMPORT_C TIntApplicationLanguage(TUidaAppUid,
TLanguage &aLanguage
)const

Parameters

TUid aAppUid
TLanguage & aLanguage

CancelListPopulationCompleteObserver()

IMPORT_C TIntCancelListPopulationCompleteObserver()const

CancelNotify()

IMPORT_C voidCancelNotify()

CancelNotifyOnDataMappingChange()

IMPORT_C voidCancelNotifyOnDataMappingChange()

CancelRecognizeFiles()

IMPORT_C voidCancelRecognizeFiles()

CleanupOperation(TAny *)

voidCleanupOperation(TAny *aAny)[private, static]

Parameters

TAny * aAny

ClearFsSession()

IMPORT_C voidClearFsSession()[static]

Close()

IMPORT_C voidClose()

CommitNonNativeApplicationsUpdatesL()

IMPORT_C voidCommitNonNativeApplicationsUpdatesL()

Connect()

IMPORT_C TIntConnect()

CreateDocument(const TDesC &, TUid, TThreadId &, TLaunchType)

IMPORT_C TIntCreateDocument(const TDesC &aDocFileName,
TUidaAppUid,
TThreadId &aThreadId,
TLaunchTypeaUnused = ELaunchNewApp
)

Parameters

const TDesC & aDocFileName
TUid aAppUid
TThreadId & aThreadId
TLaunchType aUnused = ELaunchNewApp

CreateRegFilesBufferL(const RPointerArray< TDesC > &)

CBufFlat *CreateRegFilesBufferL(const RPointerArray< TDesC > &aRegFiles)[private, static]

Parameters

const RPointerArray< TDesC > & aRegFiles

DeleteDataMapping(const TDataType &)

IMPORT_C TIntDeleteDataMapping(const TDataType &aDataType)

Parameters

const TDataType & aDataType

DeleteDataMapping(const TDataType &, TUid)

IMPORT_C TIntDeleteDataMapping(const TDataType &aDataType,
TUidaServiceUid
)

Parameters

const TDataType & aDataType
TUid aServiceUid

DeletePointerToPointerToTAny(TAny *)

voidDeletePointerToPointerToTAny(TAny *aPointerToPointerToTAny)[private, static]

Parameters

TAny * aPointerToPointerToTAny

DeregisterNonNativeApplicationL(TUid)

IMPORT_C voidDeregisterNonNativeApplicationL(TUidaApplication)

Parameters

TUid aApplication

DeregisterNonNativeApplicationTypeL(TUid)

IMPORT_C voidDeregisterNonNativeApplicationTypeL(TUidaApplicationType)

Parameters

TUid aApplicationType

DoAppCount(TInt &, TInt)

TInt DoAppCount(TInt &aCount,
TIntaCommand
)const [private]

Parameters

TInt & aCount
TInt aCommand

DoAppForDocumentOptionallySpecifyingService(const TDesC &, TUid, TUid &, TDataType &, TInt)

TInt DoAppForDocumentOptionallySpecifyingService(const TDesC &aFileName,
TUidaServiceUid,
TUid &aAppUid,
TDataType &aDataType,
TIntaOpcode
)const [private]

Parameters

const TDesC & aFileName
TUid aServiceUid
TUid & aAppUid
TDataType & aDataType
TInt aOpcode

DoAppForDocumentOptionallySpecifyingService(const RFile &, TUid, TUid &, TDataType &, TInt)

TInt DoAppForDocumentOptionallySpecifyingService(const RFile &aFile,
TUidaServiceUid,
TUid &aAppUid,
TDataType &aDataType,
TIntaOpcode
)const [private]

Parameters

const RFile & aFile
TUid aServiceUid
TUid & aAppUid
TDataType & aDataType
TInt aOpcode

DoGetAppIconSizesL(TUid, CArrayFixFlat< TSize > &)

voidDoGetAppIconSizesL(TUidaAppUid,
CArrayFixFlat< TSize > &aArrayToFill
)const [private]

Parameters

TUid aAppUid
CArrayFixFlat< TSize > & aArrayToFill

DoGetAppOwnedFilesL(CDesCArray &, TUid)

voidDoGetAppOwnedFilesL(CDesCArray &aArrayToFill,
TUidaAppUid
)const [private]

Parameters

CDesCArray & aArrayToFill
TUid aAppUid

DoGetAppViewsL(CApaAppViewArray &, TUid)

voidDoGetAppViewsL(CApaAppViewArray &aArrayToFill,
TUidaAppUid
)const [private]

Parameters

CApaAppViewArray & aArrayToFill
TUid aAppUid

DoStartApp(const CApaCommandLine &, TThreadId *, TRequestStatus *)

TInt DoStartApp(const CApaCommandLine &aCommandLine,
TThreadId *aThreadId,
TRequestStatus *aRequestStatusForRendezvous
)[private]

Parameters

const CApaCommandLine & aCommandLine
TThreadId * aThreadId
TRequestStatus * aRequestStatusForRendezvous

DoStartAppL(const CApaCommandLine &, TThreadId *, TRequestStatus *)

voidDoStartAppL(const CApaCommandLine &aCommandLine,
TThreadId *aThreadId,
TRequestStatus *aRequestStatusForRendezvous
)[private]

Parameters

const CApaCommandLine & aCommandLine
TThreadId * aThreadId
TRequestStatus * aRequestStatusForRendezvous

DoStartApplicationL(const TDesC &, const CApaCommandLine &, TThreadId &, TRequestStatus *)

voidDoStartApplicationL(const TDesC &aNativeExecutableName,
const CApaCommandLine &aCommandLine,
TThreadId &aThreadId,
TRequestStatus *aRequestStatusForRendezvous
)[private]

Parameters

const TDesC & aNativeExecutableName
const CApaCommandLine & aCommandLine
TThreadId & aThreadId
TRequestStatus * aRequestStatusForRendezvous

EmbeddableAppCount(TInt &)

IMPORT_C TIntEmbeddableAppCount(TInt &aCount)const

Parameters

TInt & aCount

FetchArrayL(MArrayFiller &, TUid, TInt, TInt)

voidFetchArrayL(MArrayFiller &aArrayFiller,
TUidaAppUid,
TIntaOpcode,
TIntaInitialBufSize
)const [private]

Parameters

MArrayFiller & aArrayFiller
TUid aAppUid
TInt aOpcode
TInt aInitialBufSize

ForceCommitNonNativeApplicationsUpdatesL()

IMPORT_C voidForceCommitNonNativeApplicationsUpdatesL()

ForceRegistration(const RPointerArray< TDesC > &)

IMPORT_C TIntForceRegistration(const RPointerArray< TDesC > &aRegFiles)

Parameters

const RPointerArray< TDesC > & aRegFiles

FsSession()

IMPORT_C RFs *FsSession()[static]

GetAcceptedConfidence(TInt &)

IMPORT_C TIntGetAcceptedConfidence(TInt &aConfidence)const

Parameters

TInt & aConfidence

GetAllApps()

IMPORT_C TIntGetAllApps()const

GetAllApps(TInt)

IMPORT_C TIntGetAllApps(TIntaScreenMode)const

Parameters

TInt aScreenMode

GetAppByDataType(const TDataType &, TUid, TUid &)

IMPORT_C TIntGetAppByDataType(const TDataType &aDataType,
TUidaServiceUid,
TUid &aAppUid
)const

Parameters

const TDataType & aDataType
TUid aServiceUid
TUid & aAppUid

GetAppCapability(TDes8 &, TUid)

IMPORT_C TIntGetAppCapability(TDes8 &aCapabilityBuf,
TUidaAppUid
)const

Parameters

TDes8 & aCapabilityBuf
TUid aAppUid

GetAppIcon(TUid, TInt, CApaMaskedBitmap &)

IMPORT_C TIntGetAppIcon(TUidaAppUid,
TIntaSize,
CApaMaskedBitmap &aAppBitmap
)const

Parameters

TUid aAppUid
TInt aSize
CApaMaskedBitmap & aAppBitmap

GetAppIcon(TUid, TSize, CApaMaskedBitmap &)

IMPORT_C TIntGetAppIcon(TUidaAppUid,
TSizeaSize,
CApaMaskedBitmap &aAppBitmap
)const

Parameters

TUid aAppUid
TSize aSize
CApaMaskedBitmap & aAppBitmap

GetAppIcon(TUid, HBufC *&)

IMPORT_C TIntGetAppIcon(TUidaAppUid,
HBufC *&aFullFileName
)const

Parameters

TUid aAppUid
HBufC *& aFullFileName

GetAppIcon(TUid, RFile &)

IMPORT_C TIntGetAppIcon(TUidaAppUid,
RFile &aFile
)const

Parameters

TUid aAppUid
RFile & aFile

GetAppIconSizes(TUid, CArrayFixFlat< TSize > &)

IMPORT_C TIntGetAppIconSizes(TUidaAppUid,
CArrayFixFlat< TSize > &aArrayToFill
)const

Parameters

TUid aAppUid
CArrayFixFlat< TSize > & aArrayToFill

GetAppInfo(TApaAppInfo &, TUid)

IMPORT_C TIntGetAppInfo(TApaAppInfo &aInfo,
TUidaAppUid
)const

Parameters

TApaAppInfo & aInfo
TUid aAppUid

GetAppOwnedFiles(CDesCArray &, TUid)

IMPORT_C TIntGetAppOwnedFiles(CDesCArray &aAppOwnedFiles,
TUidaAppUid
)const

Parameters

CDesCArray & aAppOwnedFiles
TUid aAppUid

GetAppServiceOpaqueDataLC(TUid, TUid)

IMPORT_C CApaAppServiceInfoArray *GetAppServiceOpaqueDataLC(TUidaAppUid,
TUidaServiceUid
)const

Parameters

TUid aAppUid
TUid aServiceUid

GetAppServicesL(TUid, CArrayFixFlat< TUid > &)

IMPORT_C voidGetAppServicesL(TUidaAppUid,
CArrayFixFlat< TUid > &aServiceUids
)const

Parameters

TUid aAppUid
CArrayFixFlat< TUid > & aServiceUids

GetAppServicesLC(TUid)

IMPORT_C CApaAppServiceInfoArray *GetAppServicesLC(TUidaAppUid)const

Parameters

TUid aAppUid

GetAppType(TUid &, TUid)

IMPORT_C TIntGetAppType(TUid &aTypeUid,
TUidaAppUid
)const

Parameters

TUid & aTypeUid
TUid aAppUid

GetAppViewIcon(TUid, TUid, const TSize &, CApaMaskedBitmap &)

IMPORT_C TIntGetAppViewIcon(TUidaAppUid,
TUidaViewUid,
const TSize &aSize,
CApaMaskedBitmap &aViewBitmap
)const

Parameters

TUid aAppUid
TUid aViewUid
const TSize & aSize
CApaMaskedBitmap & aViewBitmap

GetAppViewIcon(TUid, TUid, HBufC *&)

IMPORT_C TIntGetAppViewIcon(TUidaAppUid,
TUidaViewUid,
HBufC *&aFullFileName
)const

Parameters

TUid aAppUid
TUid aViewUid
HBufC *& aFullFileName

GetAppViews(CApaAppViewArray &, TUid)

IMPORT_C TIntGetAppViews(CApaAppViewArray &aAppViews,
TUidaAppUid
)const

Parameters

CApaAppViewArray & aAppViews
TUid aAppUid

GetDefaultScreenNumber(TInt &, TUid)

IMPORT_C TIntGetDefaultScreenNumber(TInt &aDefaultScreenNumber,
TUidaAppUid
)const

Parameters

TInt & aDefaultScreenNumber
TUid aAppUid

GetEmbeddableApps()

IMPORT_C TIntGetEmbeddableApps()const

GetEmbeddableApps(TInt)

IMPORT_C TIntGetEmbeddableApps(TIntaScreenMode)const

Parameters

TInt aScreenMode

GetExecutableNameAndNewOpaqueData(TDes &, TDes &, HBufC8 *&, TIpcArgs &, TInt)

TInt GetExecutableNameAndNewOpaqueData(TDes &aNativeExecutableName,
TDes &aLogicalExecutableName,
HBufC8 *&aOpaqueData,
TIpcArgs &aIpcArgs,
TIntaOpcode
)const [private]

Parameters

TDes & aNativeExecutableName
TDes & aLogicalExecutableName
HBufC8 *& aOpaqueData
TIpcArgs & aIpcArgs
TInt aOpcode

GetFilteredApps(const TApaEmbeddabilityFilter &)

IMPORT_C TIntGetFilteredApps(const TApaEmbeddabilityFilter &aFilter)const

Parameters

const TApaEmbeddabilityFilter & aFilter

GetFilteredApps(const TApaEmbeddabilityFilter &, TInt)

IMPORT_C TIntGetFilteredApps(const TApaEmbeddabilityFilter &aFilter,
TIntaScreenMode
)const

Parameters

const TApaEmbeddabilityFilter & aFilter
TInt aScreenMode

GetFilteredApps(TUint, TUint)

IMPORT_C TIntGetFilteredApps(TUintaCapabilityAttributeMask,
TUintaCapabilityAttributeValue
)const

Parameters

TUint aCapabilityAttributeMask
TUint aCapabilityAttributeValue

GetFilteredApps(TUint, TUint, TInt)

IMPORT_C TIntGetFilteredApps(TUintaCapabilityAttributeMask,
TUintaCapabilityAttributeValue,
TIntaScreenMode
)const

Parameters

TUint aCapabilityAttributeMask
TUint aCapabilityAttributeValue
TInt aScreenMode

GetMainThreadIdL(TThreadId &, const RProcess &)

voidGetMainThreadIdL(TThreadId &aThreadId,
const RProcess &aProcess
)[private, static]

Parameters

TThreadId & aThreadId
const RProcess & aProcess

GetMaxDataBufSize(TInt &)

IMPORT_C TIntGetMaxDataBufSize(TInt &aBufSize)const

Parameters

TInt & aBufSize

GetNewBufferFromFile(HBufC8 *&, const TDesC &)

TInt GetNewBufferFromFile(HBufC8 *&aBuffer,
const TDesC &aFileName
)const [private]

Parameters

HBufC8 *& aBuffer
const TDesC & aFileName

GetNewOpaqueData(HBufC8 *&, TInt)

TInt GetNewOpaqueData(HBufC8 *&aOpaqueData,
TIntaLengthOfOpaqueData
)const [private]

Parameters

HBufC8 *& aOpaqueData
TInt aLengthOfOpaqueData

GetNextApp(TApaAppInfo &)

IMPORT_C TIntGetNextApp(TApaAppInfo &aInfo)const

Parameters

TApaAppInfo & aInfo

GetNextApp(TApaAppInfo &, TInt)

IMPORT_C TIntGetNextApp(TApaAppInfo &aInfo,
TIntaScreenMode
)const

Parameters

TApaAppInfo & aInfo
TInt aScreenMode

GetPreferredBufSize(TInt &)

IMPORT_C TIntGetPreferredBufSize(TInt &aPreferredBufSize)const

Parameters

TInt & aPreferredBufSize

GetServerApps(TUid)

IMPORT_C TIntGetServerApps(TUidaServiceUid)const

Parameters

TUid aServiceUid

GetServerApps(TUid, TInt)

IMPORT_C TIntGetServerApps(TUidaServiceUid,
TIntaScreenMode
)const

Parameters

TUid aServiceUid
TInt aScreenMode

GetServiceBufferLC(TInt, TUid, TUid)

CBufBase *GetServiceBufferLC(TIntaOpcode,
TUidaUid1,
TUidaUid2 = KNullUid
)const [private]

Parameters

TInt aOpcode
TUid aUid1
TUid aUid2 = KNullUid

GetServiceBufferLC(TInt, TUid, const TDataType &)

CBufBase *GetServiceBufferLC(TIntaOpcode,
TUidaUid1,
const TDataType &aDataType
)const [private]

Parameters

TInt aOpcode
TUid aUid1
const TDataType & aDataType

GetServiceImplementationsLC(TUid)

IMPORT_C CApaAppServiceInfoArray *GetServiceImplementationsLC(TUidaServiceUid)const

Parameters

TUid aServiceUid

GetServiceImplementationsLC(TUid, const TDataType &)

IMPORT_C CApaAppServiceInfoArray *GetServiceImplementationsLC(TUidaServiceUid,
const TDataType &aDataType
)const

Parameters

TUid aServiceUid
const TDataType & aDataType

GetSupportedDataTypesL(CDataTypeArray &)

IMPORT_C TIntGetSupportedDataTypesL(CDataTypeArray &aDataTypes)const

Parameters

CDataTypeArray & aDataTypes

InsertDataMapping(const TDataType &, TDataTypePriority, TUid)

IMPORT_C TIntInsertDataMapping(const TDataType &aDataType,
TDataTypePriorityaPriority,
TUidaUid
)

Parameters

const TDataType & aDataType
TDataTypePriority aPriority
TUid aUid

InsertDataMapping(const TDataType &, TDataTypePriority, TUid, TUid)

IMPORT_C TIntInsertDataMapping(const TDataType &aDataType,
TDataTypePriorityaPriority,
TUidaUid,
TUidaServiceUid
)

Parameters

const TDataType & aDataType
TDataTypePriority aPriority
TUid aUid
TUid aServiceUid

InsertDataMappingIfHigher(const TDataType &, TDataTypePriority, TUid, TBool &)

IMPORT_C TIntInsertDataMappingIfHigher(const TDataType &aDataType,
TDataTypePriorityaPriority,
TUidaUid,
TBool &aInserted
)

Parameters

const TDataType & aDataType
TDataTypePriority aPriority
TUid aUid
TBool & aInserted

IsProgram(const TDesC &, TBool &)

IMPORT_C TIntIsProgram(const TDesC &aFileName,
TBool &aProgram
)const

Parameters

const TDesC & aFileName
TBool & aProgram

MatchesSecurityPolicy(TBool &, TUid, const TSecurityPolicy &)

IMPORT_C TIntMatchesSecurityPolicy(TBool &aMatches,
TUidaAppUid,
const TSecurityPolicy &aSecurityPolicy
)const

Parameters

TBool & aMatches
TUid aAppUid
const TSecurityPolicy & aSecurityPolicy

NotifyOnDataMappingChange(TRequestStatus &)

IMPORT_C voidNotifyOnDataMappingChange(TRequestStatus &aRequestStatus)

Parameters

TRequestStatus & aRequestStatus

NumberOfOwnDefinedIcons(TUid, TInt &)

IMPORT_C TIntNumberOfOwnDefinedIcons(TUidaAppUid,
TInt &aCount
)const

Parameters

TUid aAppUid
TInt & aCount

PrepareNonNativeApplicationsUpdatesL()

IMPORT_C voidPrepareNonNativeApplicationsUpdatesL()

RApaLsSession_Reserved1()

IMPORT_C voidRApaLsSession_Reserved1()[private, virtual]

RApaLsSession_Reserved2()

IMPORT_C voidRApaLsSession_Reserved2()[private, virtual]

RecognizeData(const TDesC8 &, TDataRecognitionResult &)

IMPORT_C TIntRecognizeData(const TDesC8 &aBuffer,
TDataRecognitionResult &aDataType
)const

Parameters

const TDesC8 & aBuffer
TDataRecognitionResult & aDataType

RecognizeData(const TDesC &, const TDesC8 &, TDataRecognitionResult &)

IMPORT_C TIntRecognizeData(const TDesC &aName,
const TDesC8 &aBuffer,
TDataRecognitionResult &aDataType
)const

Parameters

const TDesC & aName
const TDesC8 & aBuffer
TDataRecognitionResult & aDataType

RecognizeData(const RFile &, TDataRecognitionResult &)

IMPORT_C TIntRecognizeData(const RFile &aFile,
TDataRecognitionResult &aDataType
)const

Parameters

const RFile & aFile
TDataRecognitionResult & aDataType

RecognizeFilesL(const TDesC &, CDataRecognitionResultArray &)

IMPORT_C TIntRecognizeFilesL(const TDesC &aPath,
CDataRecognitionResultArray &aResult
)const

Parameters

const TDesC & aPath
CDataRecognitionResultArray & aResult

RecognizeFilesL(const TDesC &, CDataRecognitionResultArray &, TRequestStatus &)

IMPORT_C voidRecognizeFilesL(const TDesC &aPath,
CDataRecognitionResultArray &aResult,
TRequestStatus &aStatus
)

Parameters

const TDesC & aPath
CDataRecognitionResultArray & aResult
TRequestStatus & aStatus

RecognizeFilesL(const TDesC &, const TDesC8 &, CDataRecognitionResultArray &)

IMPORT_C TIntRecognizeFilesL(const TDesC &aPath,
const TDesC8 &aDataType,
CDataRecognitionResultArray &aResult
)const

Parameters

const TDesC & aPath
const TDesC8 & aDataType
CDataRecognitionResultArray & aResult

RecognizeFilesL(const TDesC &, const TDesC8 &, CDataRecognitionResultArray &, TRequestStatus &)

IMPORT_C voidRecognizeFilesL(const TDesC &aPath,
const TDesC8 &aDataType,
CDataRecognitionResultArray &aResult,
TRequestStatus &aStatus
)

Parameters

const TDesC & aPath
const TDesC8 & aDataType
CDataRecognitionResultArray & aResult
TRequestStatus & aStatus

RecognizeSpecificData(const TDesC &, const TDesC8 &, const TDataType &, TBool &)

IMPORT_C TIntRecognizeSpecificData(const TDesC &aName,
const TDesC8 &aBuffer,
const TDataType &aDataType,
TBool &aResult
)const

Parameters

const TDesC & aName
const TDesC8 & aBuffer
const TDataType & aDataType
TBool & aResult

RecognizeSpecificData(const RFile &, const TDataType &, TBool &)

IMPORT_C TIntRecognizeSpecificData(const RFile &aFile,
const TDataType &aDataType,
TBool &aResult
)const

Parameters

const RFile & aFile
const TDataType & aDataType
TBool & aResult

RegisterListPopulationCompleteObserver(TRequestStatus &)

IMPORT_C voidRegisterListPopulationCompleteObserver(TRequestStatus &aStatus)const

Parameters

TRequestStatus & aStatus

RegisterNonNativeApplicationL(TUid, const TDriveUnit &, CApaRegistrationResourceFileWriter &, CApaLocalisableResourceFileWriter *, const RFile *)

IMPORT_C voidRegisterNonNativeApplicationL(TUidaApplicationType,
const TDriveUnit &aDrive,
CApaRegistrationResourceFileWriter &aRegistrationResourceFile,
CApaLocalisableResourceFileWriter *aLocalisableResourceFile,
const RFile *aIconFile
)

Parameters

TUid aApplicationType
const TDriveUnit & aDrive
CApaRegistrationResourceFileWriter & aRegistrationResourceFile
CApaLocalisableResourceFileWriter * aLocalisableResourceFile
const RFile * aIconFile

RegisterNonNativeApplicationTypeL(TUid, const TDesC &)

IMPORT_C voidRegisterNonNativeApplicationTypeL(TUidaApplicationType,
const TDesC &aNativeExecutable
)

Parameters

TUid aApplicationType
const TDesC & aNativeExecutable

RollbackNonNativeApplicationsUpdates()

IMPORT_C TIntRollbackNonNativeApplicationsUpdates()

SendReceiveWithReconnect(TInt, const TIpcArgs &)

TInt SendReceiveWithReconnect(TIntaFunction,
const TIpcArgs &aIpcArgs
)const [private]

Parameters

TInt aFunction
const TIpcArgs & aIpcArgs

SetAcceptedConfidence(TInt)

IMPORT_C TIntSetAcceptedConfidence(TIntaConfidence)

Parameters

TInt aConfidence

SetAppShortCaption(const TDesC &, TLanguage, TUid)

IMPORT_C TIntSetAppShortCaption(const TDesC &aShortCaption,
TLanguageaLanguage,
TUidaAppUid
)

Parameters

const TDesC & aShortCaption
TLanguage aLanguage
TUid aAppUid

SetFsSessionL(RFs &)

IMPORT_C voidSetFsSessionL(RFs &aFsSession)[static]

Parameters

RFs & aFsSession

SetMaxDataBufSize(TInt)

IMPORT_C TIntSetMaxDataBufSize(TIntaBufSize)

Parameters

TInt aBufSize

SetNotify(TBool, TRequestStatus &)

IMPORT_C voidSetNotify(TBoolaCompleteImmediatelyIfNoScanImpendingOrInProgress,
TRequestStatus &aStatus
)

Parameters

TBool aCompleteImmediatelyIfNoScanImpendingOrInProgress
TRequestStatus & aStatus

StartApp(const CApaCommandLine &)

IMPORT_C TIntStartApp(const CApaCommandLine &aCommandLine)

Parameters

const CApaCommandLine & aCommandLine

StartApp(const CApaCommandLine &, TThreadId &)

IMPORT_C TIntStartApp(const CApaCommandLine &aCommandLine,
TThreadId &aThreadId
)

Parameters

const CApaCommandLine & aCommandLine
TThreadId & aThreadId

StartApp(const CApaCommandLine &, TThreadId &, TRequestStatus *)

IMPORT_C TIntStartApp(const CApaCommandLine &aCommandLine,
TThreadId &aThreadId,
TRequestStatus *aRequestStatusForRendezvous
)

Parameters

const CApaCommandLine & aCommandLine
TThreadId & aThreadId
TRequestStatus * aRequestStatusForRendezvous

StartApplicationPassingDocumentName(const TDesC &, const TDesC &, const TDesC8 *, const TDesC &, TThreadId &, TApaCommand, TRequestStatus *)

TInt StartApplicationPassingDocumentName(const TDesC &aNativeExecutableName,
const TDesC &aLogicalExecutableName,
const TDesC8 *aOpaqueData,
const TDesC &aDocumentName,
TThreadId &aThreadId,
TApaCommandaCommand,
TRequestStatus *aRequestStatusForRendezvous
)[private]

Parameters

const TDesC & aNativeExecutableName
const TDesC & aLogicalExecutableName
const TDesC8 * aOpaqueData
const TDesC & aDocumentName
TThreadId & aThreadId
TApaCommand aCommand
TRequestStatus * aRequestStatusForRendezvous

StartApplicationPassingFileHandle(const TDesC &, const TDesC &, const TDesC8 *, const RFile &, TThreadId &, TRequestStatus *)

TInt StartApplicationPassingFileHandle(const TDesC &aNativeExecutableName,
const TDesC &aLogicalExecutableName,
const TDesC8 *aOpaqueData,
const RFile &aFile,
TThreadId &aThreadId,
TRequestStatus *aRequestStatusForRendezvous
)[private]

Parameters

const TDesC & aNativeExecutableName
const TDesC & aLogicalExecutableName
const TDesC8 * aOpaqueData
const RFile & aFile
TThreadId & aThreadId
TRequestStatus * aRequestStatusForRendezvous

StartDocument(const TDesC &, TThreadId &, TLaunchType)

IMPORT_C TIntStartDocument(const TDesC &aDocFileName,
TThreadId &aThreadId,
TLaunchTypeaUnused = ELaunchNewApp
)

Parameters

const TDesC & aDocFileName
TThreadId & aThreadId
TLaunchType aUnused = ELaunchNewApp

StartDocument(const TDesC &, const TDataType &, TThreadId &, TLaunchType)

IMPORT_C TIntStartDocument(const TDesC &aDocFileName,
const TDataType &aDataType,
TThreadId &aThreadId,
TLaunchTypeaUnused = ELaunchNewApp
)

Parameters

const TDesC & aDocFileName
const TDataType & aDataType
TThreadId & aThreadId
TLaunchType aUnused = ELaunchNewApp

StartDocument(const TDesC &, TUid, TThreadId &, TLaunchType)

IMPORT_C TIntStartDocument(const TDesC &aDocFileName,
TUidaAppUid,
TThreadId &aThreadId,
TLaunchTypeaUnused = ELaunchNewApp
)

Parameters

const TDesC & aDocFileName
TUid aAppUid
TThreadId & aThreadId
TLaunchType aUnused = ELaunchNewApp

StartDocument(RFile &, TThreadId &, TRequestStatus *)

IMPORT_C TIntStartDocument(RFile &aDocFile,
TThreadId &aThreadId,
TRequestStatus *aRequestStatusForRendezvous = NULL
)

Parameters

RFile & aDocFile
TThreadId & aThreadId
TRequestStatus * aRequestStatusForRendezvous = NULL

StartDocument(RFile &, const TDataType &, TThreadId &, TRequestStatus *)

IMPORT_C TIntStartDocument(RFile &aDocFile,
const TDataType &aDataType,
TThreadId &aThreadId,
TRequestStatus *aRequestStatusForRendezvous = NULL
)

Parameters

RFile & aDocFile
const TDataType & aDataType
TThreadId & aThreadId
TRequestStatus * aRequestStatusForRendezvous = NULL

StartDocument(RFile &, TUid, TThreadId &, TRequestStatus *)

IMPORT_C TIntStartDocument(RFile &aDocFile,
TUidaAppUid,
TThreadId &aThreadId,
TRequestStatus *aRequestStatusForRendezvous = NULL
)

Parameters

RFile & aDocFile
TUid aAppUid
TThreadId & aThreadId
TRequestStatus * aRequestStatusForRendezvous = NULL

TransferAndInternalizeDataL(const TDesC &, const TInt, CDataRecognitionResultArray &)

TInt TransferAndInternalizeDataL(const TDesC &aPath,
const TIntaRequiredBufferSize,
CDataRecognitionResultArray &aResult
)const [private]

Parameters

const TDesC & aPath
const TInt aRequiredBufferSize
CDataRecognitionResultArray & aResult

Version()

IMPORT_C TVersionVersion()const

Member Enumerations Documentation

Enum TApaLsErrorCode

Enumerators

ENoMoreAppsInList = 1

A possible return value from GetNextApp(), to indicate that there are no more applications in the list.

EAppListInvalid

Indicates that an RApaLsSession member function was called before the session's application list is fully populated.

Enum TLaunchType

Defines the way an application is launched. This is no longer in use. Has no effect!

Enumerators

ELaunchNewApp = 1
ESwitchFiles

Member Data Documentation

CApaLsSessionExtension * iExtension

CApaLsSessionExtension *iExtension[private]
© Nokia 2010.