CApaCommandLine Class Reference

#include <mw/apacmdln.h>

Link against: apparc.lib

class CApaCommandLine : public CBase, public CBase

Inherits from

Public Member Enumerations
enumanonymous { EIpcFirstFreeSlot }
Public Member Functions
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()
Inherited Functions
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)

Detailed Description

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.

Member Enumeration Documentation

Enum anonymous


Constructor & Destructor Documentation

~CApaCommandLine ( )


Destructor. Frees resources owned by the object prior to deletion.

Member Function Documentation

AppStartupInstrumentationEventIdBase ( )

IMPORT_C TIntAppStartupInstrumentationEventIdBase()const

Command ( )

IMPORT_C TApaCommandCommand()const

Gets the command code from the launch information.

See the description of SetCommandL.

See also: SetCommandL TApaCommand

Return Value
The command code.

ConstructCmdLineFromMessageL ( const RMessage2 & )

IMPORT_C voidConstructCmdLineFromMessageL(const RMessage2 &aMessage)

Acts as a second constructor and completes a commandline object from the aMessage object.

DebugMemFail ( )

IMPORT_C TIntDebugMemFail()const

DefaultScreen ( )

IMPORT_C TIntDefaultScreen()const

Extracts and returns the default (startup) screen that was specified in the command line.

Return Value
A number representing the default (startup) screen. 0 (Zero) if nothing present.

DocumentName ( )

IMPORT_C TPtrCDocumentName()const

Gets the document name from the launch information.

Return Value
A pointer descriptor representing the document name. The document name is returned without any enclosing quotation marks. If the launch information contains no document name, then the pointer descriptor has zero length.

EnvironmentSlotForPublicUse ( TInt )

IMPORT_C TIntEnvironmentSlotForPublicUse(TIntaIndex)[static]

Returns the index of a process environment-slot for public use (in other words, one that is not used internally by CApaCommandLine). The number of slots available for public use is returned from NumberOfEnvironmentSlotsForPublicUse(), (this value may be increased over time). The returned value can then be passed into any of the Open(TInt,...) functions on RSessionBase, RMutex, RChunk, RCondVar, etc, or into User::GetTIntParameter(), User::GetDesParameter(), etc, depending on the type of the object in that environment slot.

aIndexThe logical index of the public environment-slot. This must be greater than or equal to zero, and less than the value returned from NumberOfEnvironmentSlotsForPublicUse().
Return Value
The physical index of an environment-slot in the local process.

ExecutableName ( )

IMPORT_C TPtrCExecutableName()const

Gets the executable name from the launch information.

Return Value
A pointer descriptor representing the executable name.

GetCommandLineFromProcessEnvironment ( CApaCommandLine *& )

IMPORT_C TIntGetCommandLineFromProcessEnvironment(CApaCommandLine *&aCommandLine)[static]

Constructs a command line object.

If command line information is provided in the environment-slots it creates command line object from process environment-slots, else creates it from the information returned by User::CommandLine().

It can be called from a context where there is no CTrapCleanup.

Calling this function more than once in a process is not supported and will result in an empty command line being returned. If an application wants to inspect any part of its command line, it should override CEikAppUi::ProcessCommandParametersL(CApaCommandLine& aCommandLine) and call the base class implementation if required.

See also: CEikAppUi::ProcessCommandParametersL(CApaCommandLine& aCommandLine).

aCommandLineOn return, a pointer to a newly constructed command line object.
Return Value
KErrNone, if successful; otherwise one of the other system-wide error codes.

GetFileByHandleL ( RFile & )

IMPORT_C voidGetFileByHandleL(RFile &aFile)const

Opens (by handle) the file that was passed into SetFileByHandleL by the process launching the local application.

On entering this function, aFile must be non-open. It is recommended that aFile is pushed onto the cleanup-stack (via CleanupClosePushL()) before this function is called.

aFileThe file object to be set up from the handle passed into the application. The caller has the responsibility to Close() this object, even if this function leaves.

GetIpcArgsLC ( TIpcArgs & )

IMPORT_C voidGetIpcArgsLC(TIpcArgs &aIpcArgs)const

IsDefaultScreenSet ( )

IMPORT_C TBoolIsDefaultScreenSet()const

NewL ( )

IMPORT_C CApaCommandLine *NewL()[static]

Creates an empty command line object.

Return Value
A pointer to the new command line object.

NewLC ( )

IMPORT_C CApaCommandLine *NewLC()[static]

Creates an empty command line object, and puts a pointer to it onto the cleanup stack.

Return Value
A pointer to the new command line object.

NumberOfEnvironmentSlotsForPublicUse ( )

IMPORT_C TIntNumberOfEnvironmentSlotsForPublicUse()[static]

The number of process environment-slot available for public use.

OpaqueData ( )

IMPORT_C TPtrC8OpaqueData()const

Gets the opaque-data from the launch information.

See the description of SetOpaqueDataL. By default, this attribute is an empty descriptor.

See also: SetOpaqueDataL

Return Value
An 8-bit pointer descriptor representing the opaque-data.

ParentProcessId ( )

IMPORT_C TProcessIdParentProcessId()const

Gets the Parent Process ID of the Child Process launched with this command line.

See the description of SetParentProcessId.

See also: SetParentProcessId

Return Value
The Parent Process ID.

ParentWindowGroupID ( )

IMPORT_C TIntParentWindowGroupID()const

Returns the ID of the parent window-group - the application should create its own window-group as a child of this parent.

Return Value
The ID of the parent window-group - the application should create its window-group as a child off this .

ServerRequired ( )

IMPORT_C TUintServerRequired()const

Gets the server differentiator.

See the description of SetServerRequiredL.

See also: SetServerRequiredL

See also: REikAppServiceBase::LaunchAppL()

Return Value
The non-zero differentiator for the server, else zero indicating a server is not required.

SetAppStartupInstrumentationEventIdBaseL ( TInt )

IMPORT_C voidSetAppStartupInstrumentationEventIdBaseL(TIntaEventIdBase)

SetCommandL ( TApaCommand )

IMPORT_C voidSetCommandL(TApaCommandaCommand)

Sets the command code.

The command code is used to indicate how an application is to be launched.

See also: TApaCommand

aCommandThe command code.

SetDebugMemFailL ( TInt )

IMPORT_C voidSetDebugMemFailL(TIntaDebugMemFail)

SetDefaultScreenL ( TInt )

IMPORT_C voidSetDefaultScreenL(TIntaDefaultScreenNumber)

Provides support for devices with more than one screen. A number representing the default or startup screen may be passed to an application. Screen numbers and characteristics are defined in the window server initialisation file (wsini.ini).

aDefaultScreenNumberThe number of the default (startup) screen.

SetDocumentNameL ( const TDesC & )

IMPORT_C voidSetDocumentNameL(const TDesC &aDocName)

Sets the document name from the specified descriptor.

If the document name has embedded spaces, then it must be enclosed within quotation marks.

aDocNameA descriptor containing the document name.

SetExecutableNameL ( const TDesC & )

IMPORT_C voidSetExecutableNameL(const TDesC &aAppName)

Sets the executable name from the specified descriptor.

aAppNameA descriptor containing the executable name.

SetFileByHandleL ( const RFile & )

IMPORT_C voidSetFileByHandleL(const RFile &aFile)

Sets the file to be passed into the application (by handle). This will then be retrieved by that application-process calling GetFileByHandleL().

aFileThe file object to be passed into the application. No transfer of this object's ownership takes place in this function.

SetOpaqueDataL ( const TDesC8 & )

IMPORT_C voidSetOpaqueDataL(const TDesC8 &aOpaqueData)

Sets the opaque-data from the specified 8-bit descriptor.

This is called internally and populated from the data in the application's registration resource file, i.e. from the resource indicated by the opaque_data field of the APP_REGISTRATION_INFO resource (if the opaque_data field was non-zero).

aOpaqueDataAn 8-bit descriptor containing the opaque-data.

SetParentProcessId ( TProcessId )

IMPORT_C voidSetParentProcessId(TProcessIdaProcessId)

Sets the Parent Process ID for the Child Process launched with this command line.

This establishes a Parent-Child relationship which ensures that the child process is terminated when the parent terminates.

aProcessIdThe Process ID.

SetParentWindowGroupID ( TInt )

IMPORT_C voidSetParentWindowGroupID(TIntaParentWindowGroupID)

Sets the ID of the parent window-group - the application should create its own window-group as a child off this parent.

aParentWindowGroupIDThe ID of the parent window-group - the application should create its window-group as a child off this parent.

SetProcessEnvironmentL ( RProcess & )

IMPORT_C voidSetProcessEnvironmentL(RProcess &aProcess)const

Assigns a command line to a process (EKA2 only).

This replaces the EKA1 method which involved retrieving the full command line (using CApaCommandLine::FullCommandLine()) and passing it to the process (or thread on the emulator).

This function is used as follows (the order of the first 2 steps is irrelevant):-

Note that this sequence of steps bypasses the application architecture, and is not recommended. RApaLsSession::StartApp() is the recommended way to launch an application with a command line.

See also: RApaLsSession::StartApp()

aProcessThe process to which the command line is assigned.
Leave Codes
KErrNotSupportedThis indicates that the function was called on EKA1.

SetServerNotRequiredL ( )

IMPORT_C voidSetServerNotRequiredL()

Sets that no server is required.

The value of server differentiator is set to zero, to indicate that no server is required.

See the description of SetServerRequiredL.

See also: SetServerRequiredL

SetServerRequiredL ( TUint )

IMPORT_C voidSetServerRequiredL(TUintaServerDifferentiator)

Sets the required server.

The server differentiator is a number generated by the client that helps to uniquely identify the server. It is used by an application to indicate whether a server should be created and how it should be named.

See also: REikAppServiceBase::LaunchAppL()

aServerDifferentiatorA differentiator for the required server.

SetTailEndL ( const TDesC8 & )

IMPORT_C voidSetTailEndL(const TDesC8 &aTailEnd)

Sets the trailing data.

The UI Framework provides a specific set of pre-defined command line options. Additional user defined or pre-defined command line options, may be passed to an application by setting the TailEnd.

aTailEndAn 8 bit descriptor containing the trailing data.

TailEnd ( )

IMPORT_C TPtrC8TailEnd()const

Gets the trailing data from the launch information.

See the description of SetTailEndL.

See also: SetTailEndL

Return Value
A pointer descriptor representing the trailing data. If the launch information contains no trailing data, then the pointer descriptor has zero length.