TAuthorityC8 Class Reference

#include <authority8.h>

class TAuthorityC8

Protected Attributes
TPtrC8	iAuthorityDes
TPtrC8	iComponent

Public Member Functions
IMPORT_C const TDesC8 &	AuthorityDes()
IMPORT_C TInt	Compare(const TAuthorityC8 &, TAuthorityComponent)
IMPORT_C HBufC *	DisplayFormL(TAuthorityComponent)
IMPORT_C const TDesC8 &	Extract(TAuthorityComponent)
IMPORT_C TBool	IsPresent(TAuthorityComponent)

Protected Member Functions
	TAuthorityC8()
void	Reset()

Detailed Description

Dependencies : TAuthorityComponent. Comments : Provides non-modifying functionality on the components of an authority object as defined in RFC2396. There are 3 components; userinfo, host and port.

The object holds descriptor pointers to the parsed authority components and a descriptor pointer to the authority. It is non-owning. It uses 8-bit descriptors.

The functionality provided by this API allows the authority components to be extracted from the parsed authority, checked for their presence in the authority and be compared with those in another TAuthorityC8 object.

Since: 6.0

Member Attribute Documentation

iAuthorityDes

TPtrC8

iAuthorityDes

[protected]

The descriptor pointer to the authority.

iComponent

TPtrC8

iComponent

[protected]

The array of descriptor pointers to the authority components.

Constructor & Destructor Documentation

TAuthorityC8 ( )

IMPORT_C

TAuthorityC8

(

)

[protected]

Constructor.

Since: 6.0

Member Function Documentation

AuthorityDes ( )

IMPORT_C const TDesC8 &

AuthorityDes

(

)

const

Retrieves the descriptor for the entire authority.

Since: 6.0

Return Value: A const reference to a descriptor pointer to the authority.

Compare ( const TAuthorityC8 &, TAuthorityComponent )

IMPORT_C TInt	Compare	(	const TAuthorityC8 &	aAuthority,
			TAuthorityComponent	aComponent
		)	const

Compares the specified component against the one in the authority passed in.

Since: 6.0

Parameters
aAuthority	The authority to compare components against.
aComponent	The enum specifying the component to compare.

Return Value: An integer value of zero if the components are the same, any other value if the components are not the same.

DisplayFormL ( TAuthorityComponent )

IMPORT_C HBufC *

DisplayFormL

(

TAuthorityComponent

aComponent = EAuthorityComplete

)

const

Create a new HBufC descriptor containing the desired component or the full Authority.

Parameters
aComponent	The component to convert into Unicode (EAuthorityScheme - EAuthorityFragment) or the full authority (EAuthorityComplete -- the default)).

Return Value: the descriptor containing the desired component.

Extract ( TAuthorityComponent )

IMPORT_C const TDesC8 &

Extract

(

TAuthorityComponent

aComponent

)

const

Retrieves the specified component in the authority.

Since: 6.0

Parameters
aComponent	The enum specifying the component.

Return Value: A constant reference to a descriptor pointer to the specified component.

IsPresent ( TAuthorityComponent )

IMPORT_C TBool

IsPresent

(

TAuthorityComponent

aComponent

)

const

Indicates whether the specified component is present in the authority.

Since: 6.0

Parameters
aComponent	The enum specifying the component.

Return Value: A boolean value of ETrue if the desired component is present, or EFalse if the desired component is not present.

Reset ( )

void

Reset

(

)

[protected]

Resets the descriptor pointers for the authority components and the authority.

Since: 6.0

Post-condition: All authority component information is removed and the authority descriptor is set to NULL.