Symbian^3 Product Developer Library >

CSsmStartupProperties Class Reference

class CSsmStartupProperties : public CBase

A parameter class containing application/process starter information that is shared among client applications, system components and client/server processes. This class is used to pass multiple different types of data to API's in only one parameter while ensuring proper data initialization, memory allocation and serializing over IPC when required.

When an instance of this class is created it contains default values for all properties. The usage of this class for different scenarios only requires calling setter functions to overrride parameters which has non-default values.

Inherits from

  • CSsmStartupProperties
Public Member Functions
~CSsmStartupProperties()
IMPORT_C TPtrCArgs()
IMPORT_C TSsmCommandTypeCommandType()
IMPORT_C TSsmExecutionBehaviourExecutionBehaviour()
IMPORT_C voidExternalizeL(RWriteStream &)
IMPORT_C TPtrCFileName()
IMPORT_C voidInternalizeL(RReadStream &)
IMPORT_C TBoolIsMonitoringRequired()
IMPORT_C TSsmMonitorInfoMonitorInfo()
IMPORT_C CSsmStartupProperties *NewL()
IMPORT_C CSsmStartupProperties *NewL(const TDesC &, const TDesC &)
IMPORT_C CSsmStartupProperties *NewL(RResourceReader &, CResourceFile *, TSsmCommandType)
IMPORT_C CSsmStartupProperties *NewL(const CSsmStartupProperties &)
IMPORT_C CSsmStartupProperties *NewLC()
IMPORT_C CSsmStartupProperties *NewLC(const TDesC &, const TDesC &)
IMPORT_C CSsmStartupProperties *NewLC(RResourceReader &, CResourceFile *, TSsmCommandType)
IMPORT_C voidReset()
IMPORT_C TIntRetries()
IMPORT_C voidSetCommandTypeL(TSsmCommandType)
IMPORT_C voidSetExecutionBehaviour(TSsmExecutionBehaviour)
IMPORT_C voidSetFileParamsL(const TDesC &, const TDesC &)
IMPORT_C voidSetMonitorInfoL(TSsmMonitorInfo)
IMPORT_C voidSetRetries(TInt)
IMPORT_C voidSetStartInBackground(TBool)
IMPORT_C voidSetTimeout(TInt32)
IMPORT_C voidSetViewless(TBool)
IMPORT_C TBoolStartInBackground()
IMPORT_C TInt32Timeout()
IMPORT_C TBoolViewless()
Private Member Functions
CSsmStartupProperties()
CSsmStartupProperties(const CSsmStartupProperties &)
voidConstructFromResourceL(RResourceReader &, CResourceFile *, TSsmCommandType)
voidConstructL(const CSsmStartupProperties &)
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
HBufC *iArgs
TSsmCommandType iCommandType
TSsmExecutionBehaviour iExecutionBehaviour
HBufC *iFileName
TSsmMonitorInfo iMonitorInfo
TBool iMonitoringRequired
TInt iReserved1
TInt iReserved2
TInt iReserved3
TInt iRetries
TBool iStartInBackground
TInt32 iTimeout
TBool iViewless

Constructor & Destructor Documentation

CSsmStartupProperties()

CSsmStartupProperties()[private]

CSsmStartupProperties(const CSsmStartupProperties &)

CSsmStartupProperties(const CSsmStartupProperties &aStartupProperties)[private]

Parameters

const CSsmStartupProperties & aStartupProperties

~CSsmStartupProperties()

IMPORT_C~CSsmStartupProperties()

Member Functions Documentation

Args()

IMPORT_C TPtrCArgs()const

CommandType()

IMPORT_C TSsmCommandTypeCommandType()const

ConstructFromResourceL(RResourceReader &, CResourceFile *, TSsmCommandType)

voidConstructFromResourceL(RResourceReader &aReader,
CResourceFile *aResourceFile,
TSsmCommandTypeaCommandType
)[private]

Parameters

RResourceReader & aReader
CResourceFile * aResourceFile
TSsmCommandType aCommandType

ConstructL(const CSsmStartupProperties &)

voidConstructL(const CSsmStartupProperties &aStartupProperties)[private]

Parameters

const CSsmStartupProperties & aStartupProperties

ExecutionBehaviour()

IMPORT_C TSsmExecutionBehaviourExecutionBehaviour()const

ExternalizeL(RWriteStream &)

IMPORT_C voidExternalizeL(RWriteStream &aWriteStream)const

Parameters

RWriteStream & aWriteStream

FileName()

IMPORT_C TPtrCFileName()const

InternalizeL(RReadStream &)

IMPORT_C voidInternalizeL(RReadStream &aReadStream)

Parameters

RReadStream & aReadStream

IsMonitoringRequired()

IMPORT_C TBoolIsMonitoringRequired()const

MonitorInfo()

IMPORT_C TSsmMonitorInfoMonitorInfo()const

NewL()

IMPORT_C CSsmStartupProperties *NewL()[static]

NewL(const TDesC &, const TDesC &)

IMPORT_C CSsmStartupProperties *NewL(const TDesC &aFileName,
const TDesC &aArgs
)[static]

Parameters

const TDesC & aFileName
const TDesC & aArgs

NewL(RResourceReader &, CResourceFile *, TSsmCommandType)

IMPORT_C CSsmStartupProperties *NewL(RResourceReader &aReader,
CResourceFile *aResourceFile,
TSsmCommandTypeaCommandType
)[static]

Parameters

RResourceReader & aReader
CResourceFile * aResourceFile
TSsmCommandType aCommandType

NewL(const CSsmStartupProperties &)

IMPORT_C CSsmStartupProperties *NewL(const CSsmStartupProperties &aStartupProperties)[static]

Parameters

const CSsmStartupProperties & aStartupProperties

NewLC()

IMPORT_C CSsmStartupProperties *NewLC()[static]

NewLC(const TDesC &, const TDesC &)

IMPORT_C CSsmStartupProperties *NewLC(const TDesC &aFileName,
const TDesC &aArgs
)[static]

Parameters

const TDesC & aFileName
const TDesC & aArgs

NewLC(RResourceReader &, CResourceFile *, TSsmCommandType)

IMPORT_C CSsmStartupProperties *NewLC(RResourceReader &aReader,
CResourceFile *aResourceFile,
TSsmCommandTypeaCommandType
)[static]

Parameters

RResourceReader & aReader
CResourceFile * aResourceFile
TSsmCommandType aCommandType

Reset()

IMPORT_C voidReset()

Retries()

IMPORT_C TIntRetries()const

SetCommandTypeL(TSsmCommandType)

IMPORT_C voidSetCommandTypeL(TSsmCommandTypeaCommandType)

Parameters

TSsmCommandType aCommandType

SetExecutionBehaviour(TSsmExecutionBehaviour)

IMPORT_C voidSetExecutionBehaviour(TSsmExecutionBehaviouraExecutionBehaviour)

Parameters

TSsmExecutionBehaviour aExecutionBehaviour

SetFileParamsL(const TDesC &, const TDesC &)

IMPORT_C voidSetFileParamsL(const TDesC &aFileName,
const TDesC &aArgs
)

Parameters

const TDesC & aFileName
const TDesC & aArgs

SetMonitorInfoL(TSsmMonitorInfo)

IMPORT_C voidSetMonitorInfoL(TSsmMonitorInfoaMonitorInfo)

Parameters

TSsmMonitorInfo aMonitorInfo

SetRetries(TInt)

IMPORT_C voidSetRetries(TIntaRetries)

Parameters

TInt aRetries

SetStartInBackground(TBool)

IMPORT_C voidSetStartInBackground(TBoolaStartInBackground)

Parameters

TBool aStartInBackground

SetTimeout(TInt32)

IMPORT_C voidSetTimeout(TInt32aTimeout)

Parameters

TInt32 aTimeout

SetViewless(TBool)

IMPORT_C voidSetViewless(TBoolaViewless)

Parameters

TBool aViewless

StartInBackground()

IMPORT_C TBoolStartInBackground()const

Timeout()

IMPORT_C TInt32Timeout()const

Viewless()

IMPORT_C TBoolViewless()const

Member Data Documentation

HBufC * iArgs

HBufC *iArgs[private]

TSsmCommandType iCommandType

TSsmCommandType iCommandType[private]

TSsmExecutionBehaviour iExecutionBehaviour

TSsmExecutionBehaviour iExecutionBehaviour[private]

HBufC * iFileName

HBufC *iFileName[private]

TSsmMonitorInfo iMonitorInfo

TSsmMonitorInfo iMonitorInfo[private]

TBool iMonitoringRequired

TBool iMonitoringRequired[private]

TInt iReserved1

TInt iReserved1[private]

TInt iReserved2

TInt iReserved2[private]

TInt iReserved3

TInt iReserved3[private]

TInt iRetries

TInt iRetries[private]

TBool iStartInBackground

TBool iStartInBackground[private]

TInt32 iTimeout

TInt32 iTimeout[private]

TBool iViewless

TBool iViewless[private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.