Class TAuthorityC16

class TAuthorityC16;

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 16-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 TAuthorityC16 object.

Members

Defined in TAuthorityC16:
AuthorityDes(), Compare(), DisplayFormL(), Extract(), IsPresent(), TAuthorityC16(), iAuthorityDes, iComponent

protected: IMPORT_C TAuthorityC16();

Description

Constructor.

IMPORT_C const TDesC16 &Extract(TAuthorityComponent aComponent) const;

Description

Retrieves the specified component in the authority.

Parameters

TAuthorityComponent aComponent The enum specifying the component.

Return value

const TDesC16 & A constant reference to a descriptor pointer to the specified component.

IMPORT_C TBool IsPresent(TAuthorityComponent aComponent) const;

Description

Indicates whether the specified component is present in the authority.

Parameters

TAuthorityComponent aComponent The enum specifying the component.

Return value

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

IMPORT_C TInt Compare(const TAuthorityC16 &aAuthority, TAuthorityComponent aComponent) const;

Description

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

Parameters

const TAuthorityC16 &aAuthority The authority to compare components against. TAuthorityComponent aComponent The enum specifying the component to compare.

Return value

TInt An integer value of zero if the components are the same, any other value if the components are not the same.

IMPORT_C const TDesC16 &AuthorityDes() const;

Description

Retrieves the descriptor for the entire authority.

Return value

const TDesC16 & A const reference to a descriptor pointer to the authority.

IMPORT_C HBufC *DisplayFormL(TAuthorityComponent aComponent=EAuthorityComplete) const;

Description

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

Parameters

TAuthorityComponent aComponent The component to convert into Unicode (EAuthorityScheme - EAuthorityFragment), the full authority (EAuthorityComplete -- the default), or the final segment of the path (EAuthorityTail).

Return value

HBufC * the descriptor containing the desired component.

protected: TPtrC16 iComponent;

Description

The array of descriptor pointers to the authority components.

protected: TPtrC16 iAuthorityDes;

Description

The descriptor pointer to the authority.