Symbian
 Developer Library

DEVELOPER LIBRARY

[Index] [Glossary] [Previous] [Next]



Location: signed.h
Link against: crypto.lib

Class CAlgorithmIdentifier

CAlgorithmIdentifier

Support

Supported from 6.0

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.

Derivation

CAlgorithmIdentifierContains an algorithm ID and any encoded parameters required by that algorithm
CBaseBase class for all classes to be instantiated on the heap

Defined in CAlgorithmIdentifier:
Algorithm(), ConstructL(), ConstructL(), EncodedParams(), NewL(), NewL(), NewLC(), NewLC(), operator==(), ~CAlgorithmIdentifier()

Inherited from CBase:
operator new()

See also:


Construction and destruction


NewL()

static CAlgorithmIdentifier* NewL(TAlgorithmId& aAlgorithmId, const TDesC8& aEncodedParams);

Description

Creates a new algorithm ID object.

Parameters

TAlgorithmId& aAlgorithmId

The algorithm ID.

const TDesC8& aEncodedParams

The encoded parameters.

Return value

CAlgorithmIdentifier*

A pointer to the new algorithm ID object.


NewL()

static CAlgorithmIdentifier* NewL(const CAlgorithmIdentifier& aAlgorithmIdentifier);

Description

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

Parameters

const CAlgorithmIdentifier& aAlgorithmIdentifier

The algorithm ID object to be copied.

Return value

CAlgorithmIdentifier*

A pointer to the new algorithm ID object.


~CAlgorithmIdentifier()

~CAlgorithmIdentifier();

Description

Destructor.

Frees all resources owned by the object.


NewLC()

static CAlgorithmIdentifier* NewLC(TAlgorithmId& aAlgorithmId, const TDesC8& aEncodedParams);

Description

Creates a new algorithm ID object.

Parameters

TAlgorithmId& aAlgorithmId

The algorithm ID.

const TDesC8& aEncodedParams

The encoded parameters.

Return value

CAlgorithmIdentifier*

A pointer to the new algorithm ID object.


NewLC()

static CAlgorithmIdentifier* NewLC(const CAlgorithmIdentifier& aAlgorithmIdentifier);

Description

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.

Return value

CAlgorithmIdentifier*

A pointer to the new algorithm ID object.


ConstructL()

virtual void ConstructL(const CAlgorithmIdentifier& aAlgorithmIdentifier);

Support

Supported from 6.1

Description

Constructs and creates an Algorithm identifier object.

Parameters

const CAlgorithmIdentifier& aAlgorithmIdentifier

The Algorithm identifier object.


ConstructL()

virtual void ConstructL(const TDesC8& aEncodedParams);

Support

Supported from 6.1

Description

Constructs and creates the encoded parameters for the Algorithm identifier object.

Parameters

const TDesC8& aEncodedParams

The encoded parameters.

[Top]


Member functions


operator==()

TBool operator==(const CAlgorithmIdentifier& aAlgorithmIdentifier) const;

Description

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

Parameters

const CAlgorithmIdentifier& aAlgorithmIdentifier

The algorithm ID object to be compared.

Return value

TBool

True, if this algorithm ID object is equal to the specified algorithm ID object; false otherwise.


Algorithm()

TAlgorithmId Algorithm() const;

Description

Gets the algorithm ID.

Return value

TAlgorithmId

The algorithm ID.


EncodedParams()

TPtrC8 EncodedParams() const;

Description

Gets the encoded parameters for the algorithm ID.

Return value

TPtrC8

The encoded parameters.

Notes: