CX509DomainName Class Reference

#include <x509gn.h>

Link against: x509.lib

class CX509DomainName : public CBase

Inherits from

CX509DomainName

Protected Attributes
HBufC *	iName
RArray< TPtrC >	iRep

Public Member Functions
	~CX509DomainName()
IMPORT_C TBool	IsWithinSubtree(const CX509DomainName &)
IMPORT_C TPtrC	Name()

Protected Member Functions
	CX509DomainName()
TBool	AddDomainL(TInt &)
TBool	AddSubdomainL(TInt &)
TBool	AddSubdomainSeparatorL(TInt &)
TBool	IsAlpha(const TChar &)
TBool	IsAlphaOrNum(const TChar &)
virtual TBool	IsValidChar(const TChar &)
virtual TBool	IsValidString(const TDesC &)

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

An X.509 domain name.

Base class for email address and DNS names.

Since: v6.0

Member Attribute Documentation

iName

HBufC *

iName

[protected]

A heap descriptor representing the full domain name.

iRep

RArray< TPtrC >

iRep

[protected]

An array of pointer descriptors representing the subdomains of the DSN name.

Constructor & Destructor Documentation

CX509DomainName ( )

CX509DomainName

(

)

[protected]

Default constructor.

~CX509DomainName ( )

IMPORT_C

~CX509DomainName

(

)

Destructor.

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

Member Function Documentation

AddDomainL ( TInt & )

TBool

AddDomainL

(

TInt &

aPos

)

[protected]

Adds a domain by its subdomains to an array of pointer descriptors.

Parameter	Description
aPos	The position within the domain name.

Returns: ETrue if the domain has been added; EFalse, otherwise.

AddSubdomainL ( TInt & )

TBool

AddSubdomainL

(

TInt &

aPos

)

[protected]

Adds a subdomain to an array of pointer descriptors.

Parameter	Description
aPos	The position within the domain name.

Returns: ETrue if the subdomain has been added; EFalse, otherwise.

AddSubdomainSeparatorL ( TInt & )

TBool

AddSubdomainSeparatorL

(

TInt &

aPos

)

[protected]

Adds a subdomain separator after each subdomain entry in an array of pointer descriptors that represent the subdomains of the domain name.

Parameter	Description
aPos	The position within the domain name.

Returns: ETrue if the subdomain separator has been added; EFalse, otherwise.

IsAlpha ( const TChar & )

TBool

IsAlpha

(

const TChar &

aChar

)

const [protected]

Tests whether the character is a letter.

Parameter	Description
aChar	The character to be tested.

Returns: ETrue if the character is a letter; EFalse, otherwise.

IsAlphaOrNum ( const TChar & )

TBool

IsAlphaOrNum

(

const TChar &

aChar

)

const [protected]

Tests whether a character is a letter or a numeral.

Parameter	Description
aChar	The character to be tested.

Returns: ETrue if the character is a letter or a numeral; EFalse, otherwise.

IsValidChar ( const TChar & )

TBool

IsValidChar

(

const TChar &

aChar

)

const [protected, virtual]

Validates a character.

Parameter	Description
aChar	The character to be validated.

Returns: ETrue if the character is valid; EFalse, otherwise.

IsValidString ( const TDesC & )

TBool

IsValidString

(

const TDesC &

aStr

)

const [protected, virtual]

Validates a string.

Parameter	Description
aStr	The string to be verified.

Returns: ETrue if the string is valid; EFalse, otherwise.

IsWithinSubtree ( const CX509DomainName & )

IMPORT_C TBool

IsWithinSubtree

(

const CX509DomainName &

aName

)

const

Tests whether every sub domain in the specified domain name is the same as the corresponding sub domain in this object, starting at the end.

For example, 'john.doe@symbian.com' is within the subtree 'symbian.com' but is not within the subtree 'john' or 'symbian'.

Parameter	Description
aName	The domain name.

Returns: ETrue, if every sub domain in the specified domain name is the same as the corresponding sub domain in this object; EFalse, otherwise.

Name ( )

IMPORT_C TPtrC

Name

(

)

const

Gets the full domain name.

Returns: A pointer descriptor representing the full domain name.