Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: x520ava.h
Link against: x500.lib

Class CX520AttributeTypeAndValue

class CX520AttributeTypeAndValue : public CBase;

Description

Contains an attribute type and a value, as defined by the X.520 standard.

A Distinguished Name object, as defined by the X.500 standard, consists of a sequence of these objects.

Derivation

Members

Defined in CX520AttributeTypeAndValue:
EncodeASN1L(), EncodeASN1LC(), EncodedValue(), ExactMatchL(), ExternalizeL(), InternalizeL(), NewL(), NewL(), NewL(), NewL(), NewL(), NewLC(), NewLC(), NewLC(), NewLC(), NewLC(), Type(), ValueL(), ~CX520AttributeTypeAndValue()

Inherited from CBase:
Delete(), Extension_(), operator new()


Construction and destruction


NewL()

static IMPORT_C CX520AttributeTypeAndValue *NewL(const TDesC8 &aBinaryData);

Description

Creates a new CX520AttributeTypeAndValue object from the specified buffer containing the encoded binary representation.

Initialises the object from its encoded binary form into an internal representation.

Parameters

const TDesC8 &aBinaryData

The encoded binary representation.

Return value

CX520AttributeTypeAndValue *

The new CX520AttributeTypeAndValue object.


NewLC()

static IMPORT_C CX520AttributeTypeAndValue *NewLC(const TDesC8 &aBinaryData);

Description

Creates a new CX520AttributeTypeAndValue object from the specified buffer containing the encoded binary representation, and puts a pointer to the new object onto the cleanup stack.

Initialises the object from its encoded binary form into an internal representation.

Parameters

const TDesC8 &aBinaryData

The encoded binary representation.

Return value

CX520AttributeTypeAndValue *

The new CX520AttributeTypeAndValue object.


NewL()

static IMPORT_C CX520AttributeTypeAndValue *NewL(const TDesC8 &aBinaryData, TInt &aPos);

Description

Creates a new CX520AttributeTypeAndValue object from the specified buffer containing the encoded binary representation, starting at the specified offset.

Initialises the object from its encoded binary form into an internal representation.

Parameters

const TDesC8 &aBinaryData

The encoded binary representation.

TInt &aPos

The offset position from which to start decoding.

Return value

CX520AttributeTypeAndValue *

The new CX520AttributeTypeAndValue object.


NewLC()

static IMPORT_C CX520AttributeTypeAndValue *NewLC(const TDesC8 &aBinaryData, TInt &aPos);

Description

Creates a new CX520AttributeTypeAndValue object from the specified buffer containing the encoded binary representation, starting at the specified offset, and puts a pointer to the new object onto the cleanup stack.

Initialises the object from its encoded binary form into an internal representation.

Parameters

const TDesC8 &aBinaryData

The encoded binary representation.

TInt &aPos

The offset position from which to start decoding.

Return value

CX520AttributeTypeAndValue *

The new CX520AttributeTypeAndValue object.


NewL()

static IMPORT_C CX520AttributeTypeAndValue *NewL(const CX520AttributeTypeAndValue &aPair);

Description

Creates a new CX520AttributeTypeAndValue object from an existing object.

This is equivalent to a copy constructor.

Parameters

const CX520AttributeTypeAndValue &aPair

The CX520AttributeTypeAndValue object.

Return value

CX520AttributeTypeAndValue *

The new CX520AttributeTypeAndValue object.


NewLC()

static IMPORT_C CX520AttributeTypeAndValue *NewLC(const CX520AttributeTypeAndValue &aPair);

Description

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

This is equivalent to a copy constructor.

Parameters

const CX520AttributeTypeAndValue &aPair

The CX520AttributeTypeAndValue object.

Return value

CX520AttributeTypeAndValue *

The new CX520AttributeTypeAndValue object.


NewL()

static IMPORT_C CX520AttributeTypeAndValue *NewL(RReadStream &aStream);

Description

Creates a new CX520AttributeTypeAndValue object from the specified read stream.

Parameters

RReadStream &aStream

Stream from which the object is to be internalised.

Return value

CX520AttributeTypeAndValue *

The new CX520AttributeTypeAndValue object.


NewLC()

static IMPORT_C CX520AttributeTypeAndValue *NewLC(RReadStream &aStream);

Description

Creates a new CX520AttributeTypeAndValue object from the specified read stream, and puts a pointer to the new object onto the cleanup stack.

Parameters

RReadStream &aStream

Stream from which the object is to be internalised.

Return value

CX520AttributeTypeAndValue *

The new CX520AttributeTypeAndValue object.


NewL()

static IMPORT_C CX520AttributeTypeAndValue *NewL(TAttributeType aType, const TDesC8 &aValue);

Description

Creates a new CX520AttributeTypeAndValue object from an attribute type and value.

Parameters

TAttributeType aType

Attribute type

const TDesC8 &aValue

Attribute value

Return value

CX520AttributeTypeAndValue *

New CX520AttributeTypeAndValue object


NewLC()

static IMPORT_C CX520AttributeTypeAndValue *NewLC(TAttributeType aType, const TDesC8 &aValue);

Description

Creates a new CX520AttributeTypeAndValue object from an attribute type and value.

Parameters

TAttributeType aType

Attribute type

const TDesC8 &aValue

Attribute value

Return value

CX520AttributeTypeAndValue *

New CX520AttributeTypeAndValue object on the cleanup stack


~CX520AttributeTypeAndValue()

IMPORT_C ~CX520AttributeTypeAndValue();

Description

Destructor.

Frees all resources owned by the object, prior to its destruction.

[Top]


Member functions


Type()

IMPORT_C const TPtrC Type() const;

Description

Gets the encoded attribute type of the object.

Return value

const TPtrC

A pointer descriptor representing the encoded attribute type.


EncodedValue()

IMPORT_C const TPtrC8 EncodedValue() const;

Description

Gets the encoded attribute value of the object.

Return value

const TPtrC8

The pointer descriptor representing the encoded attribute value.


ValueL()

virtual IMPORT_C HBufC *ValueL() const;

Description

Gets the decoded value.

Return value

HBufC *

A heap descriptor containing the decoded value.


EncodeASN1LC()

IMPORT_C CASN1EncSequence *EncodeASN1LC() const;

Description

Encodes the contents into an ASN.1 sequence object.

This is useful to insert attribute type/value pairs into other ASN.1 encoding trees.

Return value

CASN1EncSequence *

New ASN.1 sequence object containing attribute type/value pair in for of an OID and an octet string; leaves the returned object on the cleanup stack.


EncodeASN1L()

IMPORT_C CASN1EncSequence *EncodeASN1L() const;

Description

Encodes the contents into an ASN.1 sequence object.

Useful to insert attribute type/value pairs into other ASN.1 encoding trees.

Return value

CASN1EncSequence *

New ASN.1 sequence object containing attribute type/value pair in for of an OID and an octet string.


ExactMatchL()

virtual IMPORT_C TBool ExactMatchL(const CX520AttributeTypeAndValue &aElement) const;

Description

Compares the attribute type and decoded value of the specified object.

Parameters

const CX520AttributeTypeAndValue &aElement

The CX520AttributeTypeAndValue object to be compared.

Return value

TBool

ETrue, if the attribute types and the decoded values match; EFalse, otherwise.


ExternalizeL()

virtual void ExternalizeL(RWriteStream &aStream) const;

Description

Externalises an object of this class to a write stream.

The presence of this function means that the standard templated operator<<() can be used to externalise objects of this class.

Parameters

RWriteStream &aStream

Stream to which the object should be externalised.


InternalizeL()

private: virtual void InternalizeL(RReadStream &aStream);

Description

Parameters

RReadStream &aStream