Collapse all Symbian^3 Application Developer Library

CVCRunnable Class Reference

class CVCRunnable : public CBase

Container for the information on how the command should be executed: 1) app uid OR exe filename; 2) optional command line arguments

Inherits from

CVCRunnable
- CBase

Public Member Functions
	~CVCRunnable ()
IMPORT_C const TDesC8 &	Arguments ()
IMPORT_C const TDesC &	ExeName ()
IMPORT_C void	ExecuteL ()
IMPORT_C void	ExternalizeL ( RWriteStream &)
IMPORT_C CVCRunnable *	NewL ( TUid , const TDesC8 &)
IMPORT_C CVCRunnable *	NewL (const TDesC &, const TDesC8 &)
IMPORT_C CVCRunnable *	NewL ( RReadStream &)
IMPORT_C CVCRunnable *	NewL (const CVCRunnable &)
IMPORT_C const TUid	Uid ()
IMPORT_C TBool	operator== (const CVCRunnable &)

Private Member Functions
void	ConstructL ( TUid , const TDesC8 &)
void	ConstructL (const TDesC &, const TDesC8 &)
void	ConstructL ( RReadStream &)

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()

Private Attributes
HBufC8 *	iArguments
HBufC *	iExeName
TUid	iExeUid

Constructor & Destructor Documentation

~CVCRunnable()

IMPORT_C

~CVCRunnable

(

)

Destructor

Member Functions Documentation

Arguments()

IMPORT_C const TDesC8 &

Arguments

(

)

const

The arguments to be passed to the application. This object keeps the ownership of the returned value

The arguments to be passed to the application

ConstructL(TUid, const TDesC8 &)

void	ConstructL	(	TUid	aAppUid,
			const TDesC8 &	aArguments
		)	[private]

Parameters

TUid aAppUid
const TDesC8 & aArguments

ConstructL(const TDesC &, const TDesC8 &)

void	ConstructL	(	const TDesC &	aExeName,
			const TDesC8 &	aArguments
		)	[private]

Parameters

const TDesC & aExeName
const TDesC8 & aArguments

ConstructL(RReadStream &)

void

ConstructL

(

RReadStream &

aStream

)

[private]

Parameters

RReadStream & aStream

ExeName()

IMPORT_C const TDesC &

ExeName

(

)

const

ExecuteL()

IMPORT_C void

ExecuteL

(

)

const

Run the command. In case of aAppUid specified during the construction application is started via the RApaLsSession::StartApp , otherwise via the RProcess::Create

leave: System-wide error code. In particular KErrNotFound if there is no such app in the system

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Saves the object to stream

Saves the object to stream. The current format is as follows: <protocol version: int32><uid: int32; KNullUidValue if no><argument length: int32> <argument descriptor="" streamed="" by="" the="" default="" descriptor="" externalizel>=""> <exe filename="" length>=""><exe filename descriptor only if filename length is not 0>

Parameters

RWriteStream & aStream

NewL(TUid, const TDesC8 &)

IMPORT_C CVCRunnable *	NewL	(	TUid	aAppUid,
			const TDesC8 &	aArguments = KNullDesC8
		)	[static]

Factory function

leave: KErrOverflow if aArguments is longer, than KMaxVCArgumentLength

leave: KErrArgument if aAppUid is KNullUidValue

leave: KErrOverflow if aArguments is longer, than KMaxVCArgumentLength

leave: KErrArgument if aAppUid is KNullUidValue

Parameters

TUid aAppUid	UID of the application to start. Cannot be KNullUidValue
const TDesC8 & aArguments = KNullDesC8	Command line to pass to the application. This object makes a copy of the passed string

NewL(const TDesC &, const TDesC8 &)

IMPORT_C CVCRunnable *	NewL	(	const TDesC &	aExeName,
			const TDesC8 &	aArguments = KNullDesC8
		)	[static]

Factory function

leave: KErrOverflow if aArguments is longer, than KMaxVCArgumentLength or aExeName is longer, than KMaxFileName

leave: KErrUndeflow if aExeName is empty

Factory function

leave: KErrOverflow if aArguments is longer, than KMaxVCArgumentLength or aExeName is longer, than KMaxOsName

leave: KErrUndeflow if aExeName is empty

Parameters

const TDesC & aExeName	Exe-file to start. Can be full or partical name according to the RProcess::Create rules. Cannot be KNullDesC
const TDesC8 & aArguments = KNullDesC8	Command line to pass to the application. This object makes a copy of the passed string

NewL(RReadStream &)

IMPORT_C CVCRunnable *

NewL

(

RReadStream &

aStream

)

[static]

Internalizes the object from stream

leave: KErrNotSupported if the stream data format is unsupported e.g. if it has been written by newer implementation of CVCommandUi

Internalizes from stream values are read in the same order as ExternalizeL wrote them

Parameters

RReadStream & aStream

NewL(const CVCRunnable &)

IMPORT_C CVCRunnable *

NewL

(

const CVCRunnable &

aOriginal

)

[static]

Copy the existing CVRunnable

Parameters

const CVCRunnable & aOriginal

Uid()

IMPORT_C const TUid

Uid

(

)

const

operator==(const CVCRunnable &)

IMPORT_C TBool

operator==

(

const CVCRunnable &

aRunnable

)

const

Parameters

const CVCRunnable & aRunnable

Member Data Documentation

HBufC8 * iArguments

HBufC8 *

iArguments

[private]

HBufC * iExeName

HBufC *

iExeName

[private]

TUid iExeUid

TUid

iExeUid

[private]