CApaCommandLine Class Reference

class CApaCommandLine : public CBase

Information for launching an application.

To start an application, passed a CApaCommandLine object to the RApaLsSession::StartApp() method.

This class is often referred to as a command line and contains: the name of an application EXE to be launched, a document name, a command code that defines the way the application is launched trailing data; the structure of this depends on the application to be launched.

To start an application, startup parameters are set on the CApaCommandLine object that is then externalized into a stream and attached to a new RProcess object. These parameters are then used to re-populate a new CApaCommandLine object inside the process by EikStart::RunApplication() and used to bootstrap the launching application.

Inherits from

Public Member Functions
~CApaCommandLine()
IMPORT_C TIntAppStartupInstrumentationEventIdBase()
IMPORT_C TApaCommandCommand()
IMPORT_C voidConstructCmdLineFromMessageL(const RMessage2 &)
IMPORT_C TIntDebugMemFail()
IMPORT_C TIntDefaultScreen()
IMPORT_C TPtrCDocumentName()
IMPORT_C TIntEnvironmentSlotForPublicUse(TInt)
IMPORT_C TPtrCExecutableName()
IMPORT_C TIntGetCommandLineFromProcessEnvironment(CApaCommandLine *&)
IMPORT_C voidGetFileByHandleL(RFile &)
IMPORT_C voidGetIpcArgsLC(TIpcArgs &)
IMPORT_C TBoolIsDefaultScreenSet()
IMPORT_C CApaCommandLine *NewL()
IMPORT_C CApaCommandLine *NewLC()
IMPORT_C TIntNumberOfEnvironmentSlotsForPublicUse()
IMPORT_C TPtrC8OpaqueData()
IMPORT_C TProcessIdParentProcessId()
IMPORT_C TIntParentWindowGroupID()
IMPORT_C TUintServerRequired()
IMPORT_C voidSetAppStartupInstrumentationEventIdBaseL(TInt)
IMPORT_C voidSetCommandL(TApaCommand)
IMPORT_C voidSetDebugMemFailL(TInt)
IMPORT_C voidSetDefaultScreenL(TInt)
IMPORT_C voidSetDocumentNameL(const TDesC &)
IMPORT_C voidSetExecutableNameL(const TDesC &)
IMPORT_C voidSetFileByHandleL(const RFile &)
IMPORT_C voidSetOpaqueDataL(const TDesC8 &)
IMPORT_C voidSetParentProcessId(TProcessId)
IMPORT_C voidSetParentWindowGroupID(TInt)
IMPORT_C voidSetProcessEnvironmentL(RProcess &)
IMPORT_C voidSetServerNotRequiredL()
IMPORT_C voidSetServerRequiredL(TUint)
IMPORT_C voidSetTailEndL(const TDesC8 &)
IMPORT_C TPtrC8TailEnd()
Private Member Functions
CApaCommandLine()
voidDoGetCommandLineFromProcessEnvironmentL()
TInt DoGetParametersFromCommandLineString(const TDesC &)
voidExternalizeL(RWriteStream &)
voidInternalizeL(RReadStream &)
HBufC *NameOfExecutable(const TDesC &, TInt &)
voidSetServerDifferentiatorL(TUint)
HBufC8 *StreamableAttributesLC()
TPtrC StripQuotes(const TDesC &)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Public Member Enumerations
enumanonymous { EIpcFirstFreeSlot = 3 }
Private Attributes
TInt iAppStartupInstrumentationEventIdBase
TApaCommand iCommand
TInt iDebugMemFail
TInt iDefaultScreenNumber
RBuf iDocumentName
RBuf iExecutableName
RFile iFile
RBuf8 iOpaqueData
TProcessId iParentProcessId
TInt iParentWindowGroupID
TUint iServerDifferentiator
RBuf8 iTailEnd

Constructor & Destructor Documentation

CApaCommandLine()

CApaCommandLine()[private]

~CApaCommandLine()

IMPORT_C~CApaCommandLine()

Member Functions Documentation

AppStartupInstrumentationEventIdBase()

IMPORT_C TIntAppStartupInstrumentationEventIdBase()const

Command()

IMPORT_C TApaCommandCommand()const

ConstructCmdLineFromMessageL(const RMessage2 &)

IMPORT_C voidConstructCmdLineFromMessageL(const RMessage2 &aMessage)

Parameters

const RMessage2 & aMessage

DebugMemFail()

IMPORT_C TIntDebugMemFail()const

DefaultScreen()

IMPORT_C TIntDefaultScreen()const

DoGetCommandLineFromProcessEnvironmentL()

voidDoGetCommandLineFromProcessEnvironmentL()[private]

DoGetParametersFromCommandLineString(const TDesC &)

TInt DoGetParametersFromCommandLineString(const TDesC &aCmdLine)[private]

Parameters

const TDesC & aCmdLine

DocumentName()

IMPORT_C TPtrCDocumentName()const

EnvironmentSlotForPublicUse(TInt)

IMPORT_C TIntEnvironmentSlotForPublicUse(TIntaIndex)[static]

Parameters

TInt aIndex

ExecutableName()

IMPORT_C TPtrCExecutableName()const

ExternalizeL(RWriteStream &)

voidExternalizeL(RWriteStream &aStream)const [private]

Parameters

RWriteStream & aStream

GetCommandLineFromProcessEnvironment(CApaCommandLine *&)

IMPORT_C TIntGetCommandLineFromProcessEnvironment(CApaCommandLine *&aCommandLine)[static]

Parameters

CApaCommandLine *& aCommandLine

GetFileByHandleL(RFile &)

IMPORT_C voidGetFileByHandleL(RFile &aFile)const

Parameters

RFile & aFile

GetIpcArgsLC(TIpcArgs &)

IMPORT_C voidGetIpcArgsLC(TIpcArgs &aIpcArgs)const

Parameters

TIpcArgs & aIpcArgs

InternalizeL(RReadStream &)

voidInternalizeL(RReadStream &aStream)[private]

Parameters

RReadStream & aStream

IsDefaultScreenSet()

IMPORT_C TBoolIsDefaultScreenSet()const

NameOfExecutable(const TDesC &, TInt &)

HBufC *NameOfExecutable(const TDesC &aCmdLine,
TInt &aEndDocNameOffset
)[private, static]

Parameters

const TDesC & aCmdLine
TInt & aEndDocNameOffset

NewL()

IMPORT_C CApaCommandLine *NewL()[static]

NewLC()

IMPORT_C CApaCommandLine *NewLC()[static]

NumberOfEnvironmentSlotsForPublicUse()

IMPORT_C TIntNumberOfEnvironmentSlotsForPublicUse()[static]

OpaqueData()

IMPORT_C TPtrC8OpaqueData()const

ParentProcessId()

IMPORT_C TProcessIdParentProcessId()const

ParentWindowGroupID()

IMPORT_C TIntParentWindowGroupID()const

ServerRequired()

IMPORT_C TUintServerRequired()const

SetAppStartupInstrumentationEventIdBaseL(TInt)

IMPORT_C voidSetAppStartupInstrumentationEventIdBaseL(TIntaEventIdBase)

Parameters

TInt aEventIdBase

SetCommandL(TApaCommand)

IMPORT_C voidSetCommandL(TApaCommandaCommand)

Parameters

TApaCommand aCommand

SetDebugMemFailL(TInt)

IMPORT_C voidSetDebugMemFailL(TIntaDebugMemFail)

Parameters

TInt aDebugMemFail

SetDefaultScreenL(TInt)

IMPORT_C voidSetDefaultScreenL(TIntaDefaultScreenNumber)

Parameters

TInt aDefaultScreenNumber

SetDocumentNameL(const TDesC &)

IMPORT_C voidSetDocumentNameL(const TDesC &aDocName)

Parameters

const TDesC & aDocName

SetExecutableNameL(const TDesC &)

IMPORT_C voidSetExecutableNameL(const TDesC &aAppName)

Parameters

const TDesC & aAppName

SetFileByHandleL(const RFile &)

IMPORT_C voidSetFileByHandleL(const RFile &aFile)

Parameters

const RFile & aFile

SetOpaqueDataL(const TDesC8 &)

IMPORT_C voidSetOpaqueDataL(const TDesC8 &aOpaqueData)

Parameters

const TDesC8 & aOpaqueData

SetParentProcessId(TProcessId)

IMPORT_C voidSetParentProcessId(TProcessIdaProcessId)

Parameters

TProcessId aProcessId

SetParentWindowGroupID(TInt)

IMPORT_C voidSetParentWindowGroupID(TIntaParentWindowGroupID)

Parameters

TInt aParentWindowGroupID

SetProcessEnvironmentL(RProcess &)

IMPORT_C voidSetProcessEnvironmentL(RProcess &aProcess)const

Parameters

RProcess & aProcess

SetServerDifferentiatorL(TUint)

voidSetServerDifferentiatorL(TUintaServerDifferentiator)[private]

Parameters

TUint aServerDifferentiator

SetServerNotRequiredL()

IMPORT_C voidSetServerNotRequiredL()

SetServerRequiredL(TUint)

IMPORT_C voidSetServerRequiredL(TUintaServerDifferentiator)

Parameters

TUint aServerDifferentiator

SetTailEndL(const TDesC8 &)

IMPORT_C voidSetTailEndL(const TDesC8 &aTailEnd)

Parameters

const TDesC8 & aTailEnd

StreamableAttributesLC()

HBufC8 *StreamableAttributesLC()const [private]

StripQuotes(const TDesC &)

TPtrC StripQuotes(const TDesC &aDes)[private, static]

Parameters

const TDesC & aDes

TailEnd()

IMPORT_C TPtrC8TailEnd()const

Member Enumerations Documentation

Enum anonymous

Enumerators

EIpcFirstFreeSlot = 3

Member Data Documentation

TInt iAppStartupInstrumentationEventIdBase

TInt iAppStartupInstrumentationEventIdBase[private]

TApaCommand iCommand

TApaCommand iCommand[private]

TInt iDebugMemFail

TInt iDebugMemFail[private]

TInt iDefaultScreenNumber

TInt iDefaultScreenNumber[private]

RBuf iDocumentName

RBuf iDocumentName[private]

RBuf iExecutableName

RBuf iExecutableName[private]

RFile iFile

RFile iFile[private]

RBuf8 iOpaqueData

RBuf8 iOpaqueData[private]

TProcessId iParentProcessId

TProcessId iParentProcessId[private]

TInt iParentWindowGroupID

TInt iParentWindowGroupID[private]

TUint iServerDifferentiator

TUint iServerDifferentiator[private]

RBuf8 iTailEnd

RBuf8 iTailEnd[private]