CX520AttributeTypeAndValue Class Reference

#include <x520ava.h>

Link against: x500.lib

class CX520AttributeTypeAndValue : public CBase

Inherits from

CX520AttributeTypeAndValue
- CBase

Public Member Functions
	~CX520AttributeTypeAndValue()
IMPORT_C CASN1EncSequence *	EncodeASN1L()
IMPORT_C CASN1EncSequence *	EncodeASN1LC()
IMPORT_C const TPtrC8	EncodedValue()
virtual IMPORT_C TBool	ExactMatchL(const CX520AttributeTypeAndValue &)
virtual void	ExternalizeL(RWriteStream &)
IMPORT_C CX520AttributeTypeAndValue *	NewL(const TDesC8 &)
IMPORT_C CX520AttributeTypeAndValue *	NewL(const TDesC8 &, TInt &)
IMPORT_C CX520AttributeTypeAndValue *	NewL(const CX520AttributeTypeAndValue &)
IMPORT_C CX520AttributeTypeAndValue *	NewL(RReadStream &)
IMPORT_C CX520AttributeTypeAndValue *	NewL(TAttributeType, const TDesC8 &)
IMPORT_C CX520AttributeTypeAndValue *	NewLC(const TDesC8 &)
IMPORT_C CX520AttributeTypeAndValue *	NewLC(const TDesC8 &, TInt &)
IMPORT_C CX520AttributeTypeAndValue *	NewLC(const CX520AttributeTypeAndValue &)
IMPORT_C CX520AttributeTypeAndValue *	NewLC(RReadStream &)
IMPORT_C CX520AttributeTypeAndValue *	NewLC(TAttributeType, const TDesC8 &)
IMPORT_C const TPtrC	Type()
virtual IMPORT_C HBufC *	ValueL()

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

Since: v6.0

Constructor & Destructor Documentation

~CX520AttributeTypeAndValue ( )

IMPORT_C

~CX520AttributeTypeAndValue

(

)

Destructor.

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

Member Function Documentation

EncodeASN1L ( )

IMPORT_C CASN1EncSequence *

EncodeASN1L

(

)

const

Encodes the contents into an ASN.1 sequence object.

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

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

EncodeASN1LC ( )

IMPORT_C CASN1EncSequence *

EncodeASN1LC

(

)

const

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

EncodedValue ( )

IMPORT_C const TPtrC8

EncodedValue

(

)

const

Gets the encoded attribute value of the object.

Return Value: The pointer descriptor representing the encoded attribute value.

ExactMatchL ( const CX520AttributeTypeAndValue & )

IMPORT_C TBool

ExactMatchL

(

const CX520AttributeTypeAndValue &

aElement

)

const [virtual]

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

Parameters
aElement	The CX520AttributeTypeAndValue object to be compared.

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

ExternalizeL ( RWriteStream & )

void

ExternalizeL

(

RWriteStream &

aStream

)

const [virtual]

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
aStream	Stream to which the object should be externalised.

NewL ( const TDesC8 & )

IMPORT_C CX520AttributeTypeAndValue *

NewL

(

const TDesC8 &

aBinaryData

)

[static]

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
aBinaryData	The encoded binary representation.

Return Value: The new CX520AttributeTypeAndValue object.

NewL ( const TDesC8 &, TInt & )

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

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
aBinaryData	The encoded binary representation.
aPos	The offset position from which to start decoding.

Return Value: The new CX520AttributeTypeAndValue object.

NewL ( const CX520AttributeTypeAndValue & )

IMPORT_C CX520AttributeTypeAndValue *

NewL

(

const CX520AttributeTypeAndValue &

aPair

)

[static]

Creates a new CX520AttributeTypeAndValue object from an existing object.

This is equivalent to a copy constructor.

Parameters
aPair	The CX520AttributeTypeAndValue object.

Return Value: The new CX520AttributeTypeAndValue object.

NewL ( RReadStream & )

IMPORT_C CX520AttributeTypeAndValue *

NewL

(

RReadStream &

aStream

)

[static]

Creates a new CX520AttributeTypeAndValue object from the specified read stream.

Parameters
aStream	Stream from which the object is to be internalised.

Return Value: The new CX520AttributeTypeAndValue object.

NewL ( TAttributeType, const TDesC8 & )

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

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

Allocates and initializes a new attribute-value pair object from type and value.

Parameters
aType	Type of the value (see TAttributeType enum).
aValue	String value of the attribute.

Return Value: New CX520AttributeTypeAndValue objectPointer to a newly allocated and initialized attribute-value pair.

NewLC ( const TDesC8 & )

IMPORT_C CX520AttributeTypeAndValue *

NewLC

(

const TDesC8 &

aBinaryData

)

[static]

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
aBinaryData	The encoded binary representation.

Return Value: The new CX520AttributeTypeAndValue object.

NewLC ( const TDesC8 &, TInt & )

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

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
aBinaryData	The encoded binary representation.
aPos	The offset position from which to start decoding.

Return Value: The new CX520AttributeTypeAndValue object.

NewLC ( const CX520AttributeTypeAndValue & )

IMPORT_C CX520AttributeTypeAndValue *

NewLC

(

const CX520AttributeTypeAndValue &

aPair

)

[static]

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
aPair	The CX520AttributeTypeAndValue object.

Return Value: The new CX520AttributeTypeAndValue object.

NewLC ( RReadStream & )

IMPORT_C CX520AttributeTypeAndValue *

NewLC

(

RReadStream &

aStream

)

[static]

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

Parameters
aStream	Stream from which the object is to be internalised.

Return Value: The new CX520AttributeTypeAndValue object.

NewLC ( TAttributeType, const TDesC8 & )

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

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

Allocates and initializes a new attribute-value pair object from type and value. Pushes the newly allocated object onto the cleanup stack.

Parameters
aType	Type of the value (see TAttributeType enum).
aValue	String value of the attribute.

Return Value: New CX520AttributeTypeAndValue object on the cleanup stackPointer to a newly allocated and initialized attribute-value pair.

Type ( )

IMPORT_C const TPtrC

Type

(

)

const

Gets the encoded attribute type of the object.

Return Value: A pointer descriptor representing the encoded attribute type.

ValueL ( )

IMPORT_C HBufC *

ValueL

(

)

const [virtual]

Gets the decoded value.

Return Value: A heap descriptor containing the decoded value.