TAuthorityC8 Class Reference

#include <authority8.h>

class TAuthorityC8
Protected Attributes
TPtrC8 iAuthorityDes
TPtrC8 iComponent
Public Member Functions
IMPORT_C const TDesC8 &AuthorityDes()
IMPORT_C TIntCompare(const TAuthorityC8 &, TAuthorityComponent)
IMPORT_C HBufC *DisplayFormL(TAuthorityComponent)
IMPORT_C const TDesC8 &Extract(TAuthorityComponent)
IMPORT_C TBoolIsPresent(TAuthorityComponent)
Protected Member Functions
TAuthorityC8()
voidReset()

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_CTAuthorityC8()[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

Returns: A const reference to a descriptor pointer to the authority.

Compare ( const TAuthorityC8 &, TAuthorityComponent )

IMPORT_C TIntCompare(const TAuthorityC8 &aAuthority,
TAuthorityComponentaComponent
)const

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

Since
6.0
ParameterDescription
aAuthorityThe authority to compare components against.
aComponentThe enum specifying the component to compare.

Returns: 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(TAuthorityComponentaComponent = EAuthorityComplete)const

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

ParameterDescription
aComponentThe component to convert into Unicode (EAuthorityScheme - EAuthorityFragment) or the full authority (EAuthorityComplete -- the default)).

Returns: the descriptor containing the desired component.

Extract ( TAuthorityComponent )

IMPORT_C const TDesC8 &Extract(TAuthorityComponentaComponent)const

Retrieves the specified component in the authority.

Since
6.0
ParameterDescription
aComponentThe enum specifying the component.

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

IsPresent ( TAuthorityComponent )

IMPORT_C TBoolIsPresent(TAuthorityComponentaComponent)const

Indicates whether the specified component is present in the authority.

Since
6.0
ParameterDescription
aComponentThe enum specifying the component.

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

Reset ( )

voidReset()[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.