CAuthority16 Class Reference

#include <authority16.h>

class CAuthority16 : public CBase

Inherits from

  • CAuthority16
    Public Member Functions
    ~CAuthority16()
    IMPORT_C const TAuthorityC16 &Authority()
    IMPORT_C CAuthority16 *NewL(const TAuthorityC16 &)
    IMPORT_C CAuthority16 *NewL()
    IMPORT_C CAuthority16 *NewLC(const TAuthorityC16 &)
    IMPORT_C CAuthority16 *NewLC()
    IMPORT_C voidRemoveComponentL(TAuthorityComponent)
    IMPORT_C voidSetAndEscapeComponentL(const TDesC16 &, TAuthorityComponent)
    IMPORT_C voidSetComponentL(const TDesC16 &, TAuthorityComponent)
    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

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

    The object holds parsed authority information. It is owning. It uses 16-bit descriptors.

    The functionality provided by this API allows the authority components to be set or removed from this parsed authority. Also, it provides a reference to TAuthorityC16 object so that the non-modifying functionality can be used. DeprecatedDeprecated in 9.1
    Since
    6.0

    Constructor & Destructor Documentation

    ~CAuthority16 ( )

    IMPORT_C~CAuthority16()

    Destructor.

    Since
    6.0
    DeprecatedDeprecated in 9.1

    Member Function Documentation

    Authority ( )

    IMPORT_C const TAuthorityC16 &Authority()const

    Provides a reference to the parsed authority. Allows access to the non-modifying API for TAuthorityC.

    Since
    6.0
    DeprecatedDeprecated in 9.1

    Returns: A const reference to the parsed authority object.

    NewL ( const TAuthorityC16 & )

    IMPORT_C CAuthority16 *NewL(const TAuthorityC16 &aAuthority)[static]

    Static factory constructor. Uses two phase construction and leaves nothing on the CleanupStack. Creates an authority object which is a copy of the input parameter aAuthority.

    Since
    6.0
    DeprecatedDeprecated in 9.1
    Post-condition
    A fully constructed and initialized CAuthority16 object.
    ParameterDescription
    aAuthorityA reference to a parsed authority object.

    Returns: A pointer to the newly created CAuthority16 object.

    NewL ( )

    IMPORT_C CAuthority16 *NewL()[static]

    Static factory constructor. Uses two phase construction and leaves nothing on the CleanupStack. Creates an authority object which is empty.

    Since
    6.0
    DeprecatedDeprecated in 9.1
    Post-condition
    A fully constructed and initialized CAuthority16 object.

    Returns: A pointer to the newly created CAuthority16 object.

    NewLC ( const TAuthorityC16 & )

    IMPORT_C CAuthority16 *NewLC(const TAuthorityC16 &aAuthority)[static]

    Static factory constructor. Uses two phase construction and leaves a pointer to created object on the CleanupStack. Creates an authority object which is a copy of the input parameter aAuthority.

    Since
    6.0
    DeprecatedDeprecated in 9.1
    Post-condition
    A fully constructed and initialized CAuthority16 object.
    ParameterDescription
    aAuthorityA reference to a parsed authority object.

    Returns: A pointer to the newly created CAuthority16 object.

    NewLC ( )

    IMPORT_C CAuthority16 *NewLC()[static]

    Static factory constructor. Uses two phase construction and leaves a pointer to created object on the CleanupStack. Creates an authority object which is empty.

    Since
    6.0
    DeprecatedDeprecated in 9.1
    Post-condition
    A fully constructed and initialized CAuthority16 object.

    Returns: A pointer to the newly created CAuthority16 object.

    RemoveComponentL ( TAuthorityComponent )

    IMPORT_C voidRemoveComponentL(TAuthorityComponentaComponent)

    Removes the specified component from the authority. If the component does not exist then this function does nothing.

    Since
    6.0
    DeprecatedDeprecated in 9.1
    Pre-condition
    Object is fully constructed.
    Post-condition
    The authority is updated to exclude the specified component.
    ParameterDescription
    aComponentAn enum specifying the component to be removed.

    SetAndEscapeComponentL ( const TDesC16 &, TAuthorityComponent )

    IMPORT_C voidSetAndEscapeComponentL(const TDesC16 &aData,
    TAuthorityComponentaComponent
    )

    Escape encodes the component then sets the specified component in the authority. The component is set to the value given in the argument aData. If the specified component already exists then it is replaced with the new value.

    Since
    6.0
    DeprecatedDeprecated in 9.1
    Pre-condition
    Object is fully constructed.
    Post-condition
    The authority has the specified component set to the new value.
    ParameterDescription
    aDataA descriptor pointer to the new value for the authority component.
    aComponentAn enum specifying the component to be set.

    SetComponentL ( const TDesC16 &, TAuthorityComponent )

    IMPORT_C voidSetComponentL(const TDesC16 &aData,
    TAuthorityComponentaComponent
    )

    Sets the specified component in the authority. The component is set to the value given in the argument aData. If the specified component already exists then it is replaced with the new value.

    Since
    6.0
    DeprecatedDeprecated in 9.1
    Pre-condition
    Object is fully constructed.
    Post-condition
    The authority has the specified component set to the new value. KErrArgument If aComponent goes out of range.
    ParameterDescription
    aDataA descriptor pointer to the new value for the authority component.
    aComponentAn enum specifying the component to be set.
    © Nokia 2011.