Collapse all Symbian^3 Application Developer Library

TSsmSupInfo Class Reference

class TSsmSupInfo

A parameter class intended to hold the information needed to identify utility plugins which are to be loaded into the Utility Server. These DLLs must have KSsmUtilityPluginDllTypeUid as their second UID and must have a function that returns an MSsmUtility object.

The first member of this class, filename, is mandatory to identify the plugin DLL. The second member is supposed to point at the DLL ordinal function which instantiates and returns an MSsmUtility object. The prototype for this function must be MSsmUtility* NewL(void) The third member can be used for an optional validation of the third UID of the DLL.

MSsmUtility SSM_START_SSM_UTILITY_PLUGIN

Public Member Functions
	TSsmSupInfo ()
	TSsmSupInfo (const TDesC &)
	TSsmSupInfo (const TDesC &, TInt )
	TSsmSupInfo (const TDesC &, TInt , const TUid &)
	~TSsmSupInfo ()
IMPORT_C void	ExternalizeL ( RWriteStream &)
IMPORT_C const TFileName &	FileName ()
IMPORT_C TUid	Identity ()
IMPORT_C void	InternalizeL ( RReadStream &)
IMPORT_C TInt	NewLOrdinal ()
IMPORT_C void	SetL (const TDesC &, TInt , const TUid &)

Private Attributes
TFileName	iFileName
TUid	iIdentity
TInt32	iNewLOrdinal
TInt	iSpare

Constructor & Destructor Documentation

TSsmSupInfo()

IMPORT_C

TSsmSupInfo

(

)

Default constructor.

TSsmSupInfo(const TDesC &)

IMPORT_C

TSsmSupInfo

(

const TDesC &

aFileName

)

Constructor that lets you specify a DLL file name only. The DLL file name should not include the path or drive. Utility Plugin DLLs will only be loaded from the Z: drive.

The optional iIdentity member will be set to KNullUid and iNewLOrdinal will default to 1.

Parameters

const TDesC & aFileName

A Utility Plugin DLL file name without drive or path

TSsmSupInfo(const TDesC &, TInt)

IMPORT_C	TSsmSupInfo	(	const TDesC &	aFileName,
			TInt	aNewLOrdinal
		)

Constructor that lets you specify a DLL file name and ordinal function of the DLL which provides the static MSsmUtility* NewL() function. The DLL file name should not include the path or drive. Utility Plugin DLLs will only be loaded from the Z: drive.

Parameters

const TDesC & aFileName	A Utility Plugin DLL file name without drive or path
TInt aNewLOrdinal	The ordinal number of the static MSsmUtility* NewL() function

TSsmSupInfo(const TDesC &, TInt, const TUid &)

IMPORT_C	TSsmSupInfo	(	const TDesC &	aFileName,
			TInt	aNewLOrdinal,
			const TUid &	aIdentityUid
		)

Constructor that lets you specify a DLL file name, the UID3 you expect it to have and which ordinal function of the DLL provides the static MSsmUtility* NewL() function. The Utility Plugin DLL must match both filename and expected UID. The DLL file name should not include the path or drive. Utility Plugin DLLs will only be loaded from the Z: drive.

Parameters

const TDesC & aFileName	A Utility Plugin DLL file name without drive or path
TInt aNewLOrdinal	The ordinal number of the static MSsmUtility* NewL() function
const TUid & aIdentityUid	The expected UID3 in the DLL specified by aFileName

~TSsmSupInfo()

IMPORT_C

~TSsmSupInfo

(

)

Destructor.

Member Functions Documentation

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aWriteStream

)

const

Parameters

RWriteStream & aWriteStream

FileName()

IMPORT_C const TFileName &

FileName

(

)

const

Identity()

IMPORT_C TUid

Identity

(

)

const

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

aReadStream

)

Parameters

RReadStream & aReadStream

NewLOrdinal()

IMPORT_C TInt

NewLOrdinal

(

)

const

SetL(const TDesC &, TInt, const TUid &)

IMPORT_C void	SetL	(	const TDesC &	aFileName,
			TInt	aNewLOrdinal,
			const TUid &	aIdentityUid
		)

Setter for member data.

Parameters

const TDesC & aFileName	A Utility Plugin DLL file name without drive or path
TInt aNewLOrdinal	The ordinal number of the static MSsmUtility* NewL() function
const TUid & aIdentityUid	The expected UID3 in the DLL specified by aFileName, or KNullUid to skip this optional security check.

Member Data Documentation

TFileName iFileName

TFileName

iFileName

[private]

TUid iIdentity

TUid

iIdentity

[private]

TInt32 iNewLOrdinal

TInt32

iNewLOrdinal

[private]

TInt iSpare

TInt

iSpare

[private]