Symbian^3 Application 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

Public Member Functions
~CSsmStartupProperties ()
IMPORT_C TPtrC Args ()
IMPORT_C TSsmCommandType CommandType ()
IMPORT_C TSsmExecutionBehaviour ExecutionBehaviour ()
IMPORT_C void ExternalizeL ( RWriteStream &)
IMPORT_C TPtrC FileName ()
IMPORT_C void InternalizeL ( RReadStream &)
IMPORT_C TBool IsMonitoringRequired ()
IMPORT_C TSsmMonitorInfo MonitorInfo ()
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 void Reset ()
IMPORT_C TInt Retries ()
IMPORT_C void SetCommandTypeL ( TSsmCommandType )
IMPORT_C void SetExecutionBehaviour ( TSsmExecutionBehaviour )
IMPORT_C void SetFileParamsL (const TDesC &, const TDesC &)
IMPORT_C void SetMonitorInfoL ( TSsmMonitorInfo )
IMPORT_C void SetRetries ( TInt )
IMPORT_C void SetStartInBackground ( TBool )
IMPORT_C void SetTimeout ( TInt32 )
IMPORT_C void SetViewless ( TBool )
IMPORT_C TBool StartInBackground ()
IMPORT_C TInt32 Timeout ()
IMPORT_C TBool Viewless ()
Private Member Functions
CSsmStartupProperties ()
CSsmStartupProperties (const CSsmStartupProperties &)
void ConstructFromResourceL (RResourceReader &, CResourceFile *, TSsmCommandType )
void ConstructL (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 TPtrC Args ( ) const

CommandType()

IMPORT_C TSsmCommandType CommandType ( ) const

ConstructFromResourceL(RResourceReader &, CResourceFile *, TSsmCommandType)

void ConstructFromResourceL ( RResourceReader & aReader,
CResourceFile * aResourceFile,
TSsmCommandType aCommandType
) [private]

Parameters

RResourceReader & aReader
CResourceFile * aResourceFile
TSsmCommandType aCommandType

ConstructL(const CSsmStartupProperties &)

void ConstructL ( const CSsmStartupProperties & aStartupProperties ) [private]

Parameters

const CSsmStartupProperties & aStartupProperties

ExecutionBehaviour()

IMPORT_C TSsmExecutionBehaviour ExecutionBehaviour ( ) const

ExternalizeL(RWriteStream &)

IMPORT_C void ExternalizeL ( RWriteStream & aWriteStream ) const

Parameters

RWriteStream & aWriteStream

FileName()

IMPORT_C TPtrC FileName ( ) const

InternalizeL(RReadStream &)

IMPORT_C void InternalizeL ( RReadStream & aReadStream )

Parameters

RReadStream & aReadStream

IsMonitoringRequired()

IMPORT_C TBool IsMonitoringRequired ( ) const

MonitorInfo()

IMPORT_C TSsmMonitorInfo MonitorInfo ( ) 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,
TSsmCommandType aCommandType
) [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,
TSsmCommandType aCommandType
) [static]

Parameters

RResourceReader & aReader
CResourceFile * aResourceFile
TSsmCommandType aCommandType

Reset()

IMPORT_C void Reset ( )

Retries()

IMPORT_C TInt Retries ( ) const

SetCommandTypeL(TSsmCommandType)

IMPORT_C void SetCommandTypeL ( TSsmCommandType aCommandType )

Parameters

TSsmCommandType aCommandType

SetExecutionBehaviour(TSsmExecutionBehaviour)

IMPORT_C void SetExecutionBehaviour ( TSsmExecutionBehaviour aExecutionBehaviour )

Parameters

TSsmExecutionBehaviour aExecutionBehaviour

SetFileParamsL(const TDesC &, const TDesC &)

IMPORT_C void SetFileParamsL ( const TDesC & aFileName,
const TDesC & aArgs
)

Parameters

const TDesC & aFileName
const TDesC & aArgs

SetMonitorInfoL(TSsmMonitorInfo)

IMPORT_C void SetMonitorInfoL ( TSsmMonitorInfo aMonitorInfo )

Parameters

TSsmMonitorInfo aMonitorInfo

SetRetries(TInt)

IMPORT_C void SetRetries ( TInt aRetries )

Parameters

TInt aRetries

SetStartInBackground(TBool)

IMPORT_C void SetStartInBackground ( TBool aStartInBackground )

Parameters

TBool aStartInBackground

SetTimeout(TInt32)

IMPORT_C void SetTimeout ( TInt32 aTimeout )

Parameters

TInt32 aTimeout

SetViewless(TBool)

IMPORT_C void SetViewless ( TBool aViewless )

Parameters

TBool aViewless

StartInBackground()

IMPORT_C TBool StartInBackground ( ) const

Timeout()

IMPORT_C TInt32 Timeout ( ) const

Viewless()

IMPORT_C TBool Viewless ( ) 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.