Collapse all Symbian^3 Product Developer Library

CAlgorithmIdentifier Class Reference

class CAlgorithmIdentifier : public CBase

Contains an algorithm ID and any encoded parameters required by that algorithm.

An object of this type creates and owns a heap descriptor to contain the encoded parameters.

Since: v6.0

Inherits from

CAlgorithmIdentifier
- CBase

Public Member Functions
	~CAlgorithmIdentifier()
IMPORT_C TAlgorithmId	Algorithm()
IMPORT_C TPtrC8	EncodedParams()
IMPORT_C CAlgorithmIdentifier *	NewL(const CAlgorithmIdentifier &)
IMPORT_C CAlgorithmIdentifier *	NewL(TAlgorithmId &, const TDesC8 &)
IMPORT_C CAlgorithmIdentifier *	NewLC(const CAlgorithmIdentifier &)
IMPORT_C CAlgorithmIdentifier *	NewLC(TAlgorithmId &, const TDesC8 &)
IMPORT_C TBool	operator==(const CAlgorithmIdentifier &)

Protected Member Functions
	CAlgorithmIdentifier()
	CAlgorithmIdentifier(TAlgorithmId &)
IMPORT_C void	ConstructL(const CAlgorithmIdentifier &)
IMPORT_C void	ConstructL(const TDesC8 &)

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

Protected Attributes
TAlgorithmId	iAlgorithmId
HBufC8 *	iEncodedParams

Constructor & Destructor Documentation

CAlgorithmIdentifier()

IMPORT_C

CAlgorithmIdentifier

(

)

[protected]

Default constructor.

CAlgorithmIdentifier(TAlgorithmId &)

IMPORT_C

CAlgorithmIdentifier

(

TAlgorithmId &

aAlgorithmId

)

[protected]

Constructor taking the specified parameters.

Parameters

TAlgorithmId & aAlgorithmId

The algorithm ID.

~CAlgorithmIdentifier()

IMPORT_C

~CAlgorithmIdentifier

(

)

Destructor.

Frees all resources owned by the object.

Member Functions Documentation

Algorithm()

IMPORT_C TAlgorithmId

Algorithm

(

)

const

Gets the algorithm identifier.

ConstructL(const CAlgorithmIdentifier &)

IMPORT_C void

ConstructL

(

const CAlgorithmIdentifier &

aAlgorithmIdentifier

)

[protected, virtual]

Second-phase constructor taking an existing algorithm identifier object.

Parameters

const CAlgorithmIdentifier & aAlgorithmIdentifier

The algorithm identifier object.

ConstructL(const TDesC8 &)

IMPORT_C void

ConstructL

(

const TDesC8 &

aEncodedParams

)

[protected, virtual]

Second-phase constructor taking encoded parameters.

Parameters

const TDesC8 & aEncodedParams

The encoded parameters.

EncodedParams()

IMPORT_C TPtrC8

EncodedParams

(

)

const

Gets the encoded parameters for the algorithm identifier.

Note that this object owns the heap descriptor that owns the encoded parameters.

NewL(const CAlgorithmIdentifier &)

IMPORT_C CAlgorithmIdentifier *

NewL

(

const CAlgorithmIdentifier &

aAlgorithmIdentifier

)

[static]

Creates a new algorithm ID object copied from an existing object.

Parameters

const CAlgorithmIdentifier & aAlgorithmIdentifier

The algorithm ID object to be copied.

NewL(TAlgorithmId &, const TDesC8 &)

IMPORT_C CAlgorithmIdentifier *	NewL	(	TAlgorithmId &	aAlgorithmId,
			const TDesC8 &	aEncodedParams
		)	[static]

Creates a new algorithm ID object.

Parameters

TAlgorithmId & aAlgorithmId	The algorithm ID.
const TDesC8 & aEncodedParams	The encoded parameters.

NewLC(const CAlgorithmIdentifier &)

IMPORT_C CAlgorithmIdentifier *

NewLC

(

const CAlgorithmIdentifier &

aAlgorithmIdentifier

)

[static]

Creates a new algorithm ID object copied from an existing object, and puts a pointer to the new object onto the cleanup stack.

Parameters

const CAlgorithmIdentifier & aAlgorithmIdentifier

The algorithm ID object to be copied.

NewLC(TAlgorithmId &, const TDesC8 &)

IMPORT_C CAlgorithmIdentifier *	NewLC	(	TAlgorithmId &	aAlgorithmId,
			const TDesC8 &	aEncodedParams
		)	[static]

Creates a new algorithm ID object, and puts a pointer to the new object onto the cleanup stack.

Parameters

TAlgorithmId & aAlgorithmId	The algorithm ID.
const TDesC8 & aEncodedParams	The encoded parameters.

operator==(const CAlgorithmIdentifier &)

IMPORT_C TBool

operator==

(

const CAlgorithmIdentifier &

aAlgorithmIdentifier

)

const

Tests whether this algorithm identifier object is equal to the specified algorithm identifier object.

Parameters

const CAlgorithmIdentifier & aAlgorithmIdentifier

The algorithm identifier object to be compared.

Member Data Documentation

TAlgorithmId iAlgorithmId

TAlgorithmId

iAlgorithmId

[protected]

The algorithm ID.

HBufC8 * iEncodedParams

HBufC8 *

iEncodedParams

[protected]

The encoded parameters for the algorithm ID.