Symbian
Developer Library

DEVELOPER LIBRARY

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

 » Developer Library » API Reference » C++ API reference » Certificate Manager » CX500DistinguishedName

Location: x500dn.h
Link against: x500.lib

Class CX500DistinguishedName

CX500DistinguishedName

Support

Supported from 6.0

Description

A collection of 'attribute type and value' objects, as defined by the X.520 standard.

A Distinguished Name traces a path through an X.500 Directory Information Tree.

Derivation

CBaseBase class for all classes to be instantiated on the heap
CX500DistinguishedNameA collection of 'attribute type and value' objects, as defined by the X.520 standard

Defined in CX500DistinguishedName:
Count(), Element(), ExactMatchL(), ExternalizeL(), IsWithinSubtreeL(), MatchElementL(), NewL(), NewL(), NewL(), NewL(), NewL(), NewLC(), NewLC(), NewLC(), NewLC(), NewLC(), ~CX500DistinguishedName()

Inherited from CBase:
operator new()

Construction and destruction

NewL()

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

Description

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

Parameters

const TDesC8& aBinaryData

The encoded binary representation.
const TInt& aPos

The position from which to start decoding.

Return value

CX500DistinguishedName*

The new Distinguished name object.

NewL()

static CX500DistinguishedName* NewL(const TDesC8& aBinaryData);

Description

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

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

Parameters

const TDesC8& aBinaryData

The encoded binary representation.

Return value

CX500DistinguishedName*

The new Distinguished name object.

NewL()

static CX500DistinguishedName* NewL(RReadStream& aStream);

Description

Creates a new Distinguished name object from the specified read stream.

Construction is from a stream.

Parameters

RReadStream& aStream

The read stream.

Return value

CX500DistinguishedName*

The newDistinguished name object.

NewL()

static CX500DistinguishedName* NewL(const CArrayPtr<CX520AttributeTypeAndValue>& aElements);

Description

Creates a new Distinguished name object from the specified array of 'attribute type and value' objects.

The elements of the specified array are copied into this object.

Parameters

const CArrayPtrCX520AttributeTypeAndValue& aElements

The array of 'attribute type and value' objects to be copied.

Return value

CX500DistinguishedName*

The new Distinguished name object.

NewL()

static CX500DistinguishedName* NewL(const CX500DistinguishedName& aName);

Description

Creates a new Distinguished name object from an existing object.

This is equivalent to a copy constructor.

Parameters

const CX500DistinguishedName& aName

The Distinguished name object to be copied.

Return value

CX500DistinguishedName*

The new Distinguished name object.

NewLC()

static CX500DistinguishedName* NewLC(const TDesC8& aBinaryData);

Description

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

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

Parameters

const TDesC8& aBinaryData

The encoded binary representation.

Return value

CX500DistinguishedName*

The new Distinguished name object.

NewLC()

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

Description

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

Parameters

const TDesC8& aBinaryData

The encoded binary representation.
const TInt& aPos

The position from which to start decoding.

Return value

CX500DistinguishedName*

The new Distinguished name object.

NewLC()

static CX500DistinguishedName* NewLC(RReadStream& aStream); 

Description

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

Parameters

RReadStream& aStream

The read stream.

Return value

CX500DistinguishedName*

The new Distinguished name object.

NewLC()

static CX500DistinguishedName* NewLC(const CArrayPtr<CX520AttributeTypeAndValue>& aElements); 

Description

Creates a new Distinguished name object from the specified array of 'attribute type and value' objects, and puts a pointer to it onto the cleanup stack.

The elements of the specified array are copied into this object.

Parameters

const CArrayPtrCX520AttributeTypeAndValue& aElements

The array of 'attribute type and value' objects to be copied.

Return value

CX500DistinguishedName*

The new Distinguished name object.

NewLC()

static CX500DistinguishedName* NewLC(const CX500DistinguishedName& aName);

Description

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

This is equivalent to a copy constructor.

Parameters

const CX500DistinguishedName& aName

The Distinguished name object to be copied.

Return value

CX500DistinguishedName*

The new Distinguished name object.

~CX500DistinguishedName()

~CX500DistinguishedName();

Description

Destructor.

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

[Top]

Member functions

ExternalizeL()

void ExternalizeL(RWriteStream& aStream) const;

Description

Externalizes the object to a stream.

Parameters

RWriteStream& aStream

The write stream.

Count()

TInt Count() const;

Description

Gets the number of 'attribute type and value' objects contained by this Distinguished name object.

Return value

TInt

The number of 'attribute type and value' objects.

Element()

const CX520AttributeTypeAndValue& Element(TInt aIndex) const;

Description

Gets a reference to specific 'attribute type and value' object as identified by the specified index.

Parameters

TInt aIndex

The index number identifying the specific 'attribute type and value' object. This number is relative to zero. This value must be non-negative and less than the number of objects currently contained by this Distinguished name object.

Return value

CX520AttributeTypeAndValue&

The referenced 'attribute type and value' object.

ExactMatchL()

TBool ExactMatchL(const CX500DistinguishedName& aName) const;

Description

Compares the specified Distinguished name object with this Distinguished name object.

Parameters

const CX500DistinguishedName& aName

The Distinguished name object to be compared.

Return value

TBool

True, if the Distinguished name objects contain exactly the same 'attribute type and value' objects; false, otherwise.

See also:

IsWithinSubtreeL()

TBool IsWithinSubtreeL(const CX500DistinguishedName& aName) const;

Description

Tests whether all 'attribute type and value' objects contained in the specified Distinguished name object are also contained within this Distinguished name object.

Parameters

const CX500DistinguishedName& aName

The Distinguished name object to be compared.

Return value

TBool

True, if all 'attribute type and value' objects contained in the specified Distinguished name object are also contained within this Distinguished name object; false, otherwise.

MatchElementL()

TBool MatchElementL(const CX520AttributeTypeAndValue& aElement) const;

Description

Tests whether this Distinguished name object contains the specified 'attribute type and value' object.

Parameters

const CX520AttributeTypeAndValue& aElement

The 'attribute type and value' object to be checked.

Return value

TBool

True, if the specified 'attribute type and value' object is contained in this Distinguished name object; false otherwise.

©2002 Symbian Ltd.

[Top]