CAlgorithmIdentifier Class Reference

#include <signed.h>

Link against: crypto.lib

class CAlgorithmIdentifier : public CBase

Inherits from

CAlgorithmIdentifier
- CBase

Protected Attributes
TAlgorithmId	iAlgorithmId
HBufC8 *	iEncodedParams

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 &)
virtual IMPORT_C void	ConstructL(const CAlgorithmIdentifier &)
virtual 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()

Detailed Description

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

Member Attribute Documentation

iAlgorithmId

TAlgorithmId

iAlgorithmId

[protected]

The algorithm ID.

iEncodedParams

HBufC8 *

iEncodedParams

[protected]

The encoded parameters for the algorithm ID.

Constructor & Destructor Documentation

CAlgorithmIdentifier ( )

IMPORT_C

CAlgorithmIdentifier

(

)

[protected]

Default constructor.

CAlgorithmIdentifier ( TAlgorithmId & )

IMPORT_C

CAlgorithmIdentifier

(

TAlgorithmId &

aAlgorithmId

)

[protected]

Constructor taking the specified parameters.

Parameters
aAlgorithmId	The algorithm ID.

~CAlgorithmIdentifier ( )

IMPORT_C

~CAlgorithmIdentifier

(

)

Destructor.

Frees all resources owned by the object.

Member Function Documentation

Algorithm ( )

IMPORT_C TAlgorithmId

Algorithm

(

)

const

Gets the algorithm identifier.

Return Value: 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
aAlgorithmIdentifier	The algorithm identifier object.

ConstructL ( const TDesC8 & )

IMPORT_C void

ConstructL

(

const TDesC8 &

aEncodedParams

)

[protected, virtual]

Second-phase constructor taking encoded parameters.

Parameters
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.

Return Value: 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
aAlgorithmIdentifier	The algorithm ID object to be copied.

Return Value: A pointer to the new algorithm ID object.

NewL ( TAlgorithmId &, const TDesC8 & )

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

Creates a new algorithm ID object.

Parameters
aAlgorithmId	The algorithm ID.
aEncodedParams	The encoded parameters.

Return Value: A pointer to the new algorithm ID object.

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
aAlgorithmIdentifier	The algorithm ID object to be copied.

Return Value: A pointer to the new algorithm ID object.

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
aAlgorithmId	The algorithm ID.
aEncodedParams	The encoded parameters.

Return Value: A pointer to the new algorithm ID object.

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
aAlgorithmIdentifier	The algorithm identifier object to be compared.

Return Value: ETrue, if this algorithm identifier object is equal to the specified algorithm identifier object; EFalse otherwise.