Collapse all Symbian^3 Product Developer Library

CSsmCustomCommandInfo Class Reference

class CSsmCustomCommandInfo : public CBase

Information required to construct a custom command. TCmdCustomCommandLibUnloading CCmdCustomCommand

Inherits from

CSsmCustomCommandInfo
- CBase

Public Member Functions
	CSsmCustomCommandInfo()
	~CSsmCustomCommandInfo()
IMPORT_C void	Clear()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C const TFileName &	FileName()
IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C TInt32	Ordinal()
IMPORT_C const TPtrC8	Params()
IMPORT_C TInt16	Retries()
IMPORT_C void	SetL(const TDesC &, TInt32, TCmdCustomCommandLibUnloading, TInt16, const TDesC8 &)
IMPORT_C TCmdCustomCommandLibUnloading	Unloading()
IMPORT_C CSsmCustomCommandInfo &	operator=(const CSsmCustomCommandInfo &)

Private Member Functions
	CSsmCustomCommandInfo(const CSsmCustomCommandInfo &)

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
TFileName	iFileName
TInt32	iOrdinal
HBufC8 *	iParams
TInt16	iRetries
TCmdCustomCommandLibUnloading	iUnloading

Constructor & Destructor Documentation

CSsmCustomCommandInfo()

IMPORT_C

CSsmCustomCommandInfo

(

)

Constructor

CSsmCustomCommandInfo(const CSsmCustomCommandInfo &)

CSsmCustomCommandInfo

(

const CSsmCustomCommandInfo &

aInfo

)

[private]

Parameters

const CSsmCustomCommandInfo & aInfo

~CSsmCustomCommandInfo()

IMPORT_C

~CSsmCustomCommandInfo

(

)

Destructor

Member Functions Documentation

Clear()

IMPORT_C void

Clear

(

)

Clear command info contents and reset to default values

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aWriteStream

)

const

Externalises the CSsmCustomCommandInfo object

leave: One of the system-wide error codes.

Parameters

RWriteStream & aWriteStream

A write stream to write the object data to

FileName()

IMPORT_C const TFileName &

FileName

(

)

const

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

aReadStream

)

Configures the CSsmCustomCommandInfo object using data contained in a ReadStream

leave: One of the system-wide error codes.

Parameters

RReadStream & aReadStream

A read stream containing BIC data

Ordinal()

IMPORT_C TInt32

Ordinal

(

)

const

Params()

IMPORT_C const TPtrC8

Params

(

)

const

Retries()

IMPORT_C TInt16

Retries

(

)

const

SetL(const TDesC &, TInt32, TCmdCustomCommandLibUnloading, TInt16, const TDesC8 &)

IMPORT_C void	SetL	(	const TDesC &	aFileName,
			TInt32	aOrdinal,
			TCmdCustomCommandLibUnloading	aUnloading,
			TInt16	aRetries,
			const TDesC8 &	aParams
		)

Set command info contents

leave: One of the system-wide error codes.

Parameters

const TDesC & aFileName	A Custom Command DLL file name
TInt32 aOrdinal	The ordinal to call to return a MSsmCustomCommand object
TCmdCustomCommandLibUnloading aUnloading	Whether to unload the Custom Command DLL immediately when finished or not
TInt16 aRetries	The number of times to try calling the Custom Command if unsuccessful
const TDesC8 & aParams	Optional user data to be passed to the Custom Command