Collapse all Symbian^3 Product Developer Library

Swi::CSisRegistryPackage Class Reference

class Swi::CSisRegistryPackage : public CBase

This class holds the objects that take the Uid, Name and vendor name to make a registry entry. Whenever some application is going to install, the method will take the given parameters and return one object or address of the object.

Inherits from

Swi::CSisRegistryPackage
- CBase

Public Member Functions
	~CSisRegistryPackage()
IMPORT_C void	ExternalizeL(RWriteStream &)
TInt	Index()
IMPORT_C void	InternalizeL(RReadStream &)
const TDesC &	Name()
IMPORT_C CSisRegistryPackage *	NewL(TUid, const TDesC &, const TDesC &)
IMPORT_C CSisRegistryPackage *	NewL(RReadStream &)
IMPORT_C CSisRegistryPackage *	NewL(const CSisRegistryPackage &)
IMPORT_C CSisRegistryPackage *	NewLC(TUid, const TDesC &, const TDesC &)
IMPORT_C CSisRegistryPackage *	NewLC(RReadStream &)
IMPORT_C CSisRegistryPackage *	NewLC(const CSisRegistryPackage &)
void	SetIndex(const TInt)
IMPORT_C void	SetNameL(const TDesC &)
TUid	Uid()
const TDesC &	Vendor()
IMPORT_C TBool	operator==(const CSisRegistryPackage &)

Protected Member Functions
	CSisRegistryPackage()
	CSisRegistryPackage(TUid)
void	ConstructL(const TDesC &, const TDesC &)
void	ConstructL(RReadStream &)
void	ConstructL(const CSisRegistryPackage &)

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

Public Member Enumerations
enum	anonymous { PrimaryIndex = 0x00000000, UnInitializedIndex = 0xFFFFFFFF }

Protected Attributes
TInt	iIndex
HBufC *	iPackageName
TUid	iUid
HBufC *	iVendorName

Constructor & Destructor Documentation

CSisRegistryPackage()

CSisRegistryPackage

(

)

[protected]

The constructor.

CSisRegistryPackage(TUid)

CSisRegistryPackage

(

TUid

aUid

)

[protected]

The constructor

Parameters

TUid aUid

TUid used to initialise the package.

~CSisRegistryPackage()

IMPORT_C

~CSisRegistryPackage

(

)

[virtual]

The Destructor.

Member Functions Documentation

ConstructL(const TDesC &, const TDesC &)

void	ConstructL	(	const TDesC &	aName,
			const TDesC &	aVendor
		)	[protected]

The second-phase constructor.

Parameters

const TDesC & aName	The package name.
const TDesC & aVendor

ConstructL(RReadStream &)

void

ConstructL

(

RReadStream &

aStream

)

[protected]

The second-phase constructor.

Parameters

RReadStream & aStream

RReadStream stream object reference which contains the streamed object.

ConstructL(const CSisRegistryPackage &)

void

ConstructL

(

const CSisRegistryPackage &

aPackage

)

[protected]

The second-phase constructor.

Parameters

const CSisRegistryPackage & aPackage

The package to copy from.

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Writes object data to stream

Parameters

RWriteStream & aStream

Stream to write the object data to

Index()

TInt

Index

(

)

const [inline]

The package index. Index is zero for base packages and non zero for augmentations This method is used to get the package index.

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Reads object data from stream

Parameters

RReadStream & aStream

Stream to read the object from

Name()

const TDesC &

Name

(

)

const [inline]

The package name. This method is used to get the package name.

NewL(TUid, const TDesC &, const TDesC &)

IMPORT_C CSisRegistryPackage *	NewL	(	TUid	aUid,
			const TDesC &	aName,
			const TDesC &	aVendor
		)	[static]

This method creates a new CSisRegistryPackage object

Parameters

TUid aUid	The Uid of the application
const TDesC & aName	The name of the application
const TDesC & aVendor	The name of the Vendor

NewL(RReadStream &)

IMPORT_C CSisRegistryPackage *

NewL

(

RReadStream &

aStream

)

[static]

This method creates a new CSisRegistryPackage object from a stream

Parameters

RReadStream & aStream

Stream to read the object from

NewL(const CSisRegistryPackage &)

IMPORT_C CSisRegistryPackage *

NewL

(

const CSisRegistryPackage &

aPackage

)

[static]

Construct an object from an existing one

Parameters

const CSisRegistryPackage & aPackage

The package to copy from

NewLC(TUid, const TDesC &, const TDesC &)

IMPORT_C CSisRegistryPackage *	NewLC	(	TUid	aUid,
			const TDesC &	aName,
			const TDesC &	aVendor
		)	[static]

This method creates a new CSisRegistryPackage object on the cleanup stack

Parameters

TUid aUid	The Uid of the application
const TDesC & aName	The name of the application
const TDesC & aVendor	The name of the Vendor

NewLC(RReadStream &)

IMPORT_C CSisRegistryPackage *

NewLC

(

RReadStream &

aStream

)

[static]

This method creates a new CSisRegistryPackage object from a stream on the cleanup stack

Parameters

RReadStream & aStream

Stream to read the object data from

NewLC(const CSisRegistryPackage &)

IMPORT_C CSisRegistryPackage *

NewLC

(

const CSisRegistryPackage &

aPackage

)

[static]

Construct an object from an existing one and place it on the cleanup stack

Parameters

const CSisRegistryPackage & aPackage

The package to copy from

SetIndex(const TInt)

void

SetIndex

(

const TInt

aIndex

)

[inline]

Sets the package index. This method Sets the package index.

Parameters

const TInt aIndex

index as TInt.

SetNameL(const TDesC &)

IMPORT_C void

SetNameL

(

const TDesC &

aName

)

Sets the localized package name.

Parameters

const TDesC & aName

string as TDesC.

Uid()

TUid

Uid

(

)

const [inline]

The package Uid. This method is used to get the package Uid.

Vendor()

const TDesC &

Vendor

(

)

const [inline]

The package unique vendor name. This method is used to get the package unique vendor name.

operator==(const CSisRegistryPackage &)

IMPORT_C TBool

operator==

(

const CSisRegistryPackage &

aOther

)

const

Compares two CSisRegistryPackage objects for equality.

Parameters

const CSisRegistryPackage & aOther

The object contains the name, Uid and vendor name to make a registry entry

Member Enumerations Documentation

Enum anonymous

Enumerators

PrimaryIndex = 0x00000000
UnInitializedIndex = 0xFFFFFFFF

Member Data Documentation

TInt iIndex

TInt

iIndex

[protected]

HBufC * iPackageName

HBufC *

iPackageName

[protected]

TUid iUid

TUid

iUid

[protected]

HBufC * iVendorName

HBufC *

iVendorName

[protected]