CVPbkContactLinkArray Class Reference

#include <app/CVPbkContactLinkArray.h>

Link against: VPbkEng.lib

class CVPbkContactLinkArray : public CBase

Inherits from

  • CVPbkContactLinkArray
    Public Member Functions
    ~CVPbkContactLinkArray()
    IMPORT_C voidAppendL(MVPbkContactLink *)
    const MVPbkContactLink &At(TInt)
    TInt Count()
    IMPORT_C voidDelete(TInt)
    TInt Find(const MVPbkContactLink &)
    IMPORT_C voidInsertL(MVPbkContactLink *, TInt)
    IMPORT_C CVPbkContactLinkArray *NewL()
    IMPORT_C CVPbkContactLinkArray *NewLC()
    IMPORT_C CVPbkContactLinkArray *NewLC(const TDesC8 &, const MVPbkContactStoreList &)
    IMPORT_C CVPbkContactLinkArray *NewLC(RReadStream &, const MVPbkContactStoreList &)
    CVPbkContactLinkArray *NewLC(RReadStream &, MVPbkContactStoreLoader &)
    HBufC8 *PackLC()
    IMPORT_C TIntPackedBufferSize()
    IMPORT_C voidRemove(TInt)
    IMPORT_C voidReset()
    IMPORT_C voidResetAndDestroy()
    const MVPbkStreamable *Streamable()
    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

    A read-only array of contact links.

    Constructor & Destructor Documentation

    ~CVPbkContactLinkArray ( )

    ~CVPbkContactLinkArray()

    Destructor.

    Member Function Documentation

    AppendL ( MVPbkContactLink * )

    IMPORT_C voidAppendL(MVPbkContactLink *aLink)

    Appends a link to this array.

    Pre-condition
    aLink != NULL
    Post-condition
    Array count is increased by one and the link is in the last element of the array.
    ParameterDescription
    aLinkthe link object to append. This array takes ownership of the link if append is succesful.

    At ( TInt )

    const MVPbkContactLink &At(TIntaIndex)const

    Count ( )

    TInt Count()const

    Delete ( TInt )

    IMPORT_C voidDelete(TIntaIndex)

    Removes and deletes a link at aIndex from this array.

    Pre-condition
    aIndex >= 0 && aIndex <= Count()
    Post-condition
    The array count is decreased by one.

    Find ( const MVPbkContactLink & )

    TInt Find(const MVPbkContactLink &aLink)const

    InsertL ( MVPbkContactLink *, TInt )

    IMPORT_C voidInsertL(MVPbkContactLink *aLink,
    TIntaIndex
    )

    Inserts a link to this array.

    Exceptions
    KErrNoMemory

    if out of memory.

    Pre-condition
    aLink != NULL

    aIndex >= 0 && aIndex <= Count()

    Post-condition
    Array count is increased by one and the link is in the position marked by the aIndex element of the array.
    ParameterDescription
    aLinkthe link object to insert. This array takes ownership of the link if insertion is succesful.
    aIndexposition where to insert the link.

    NewL ( )

    IMPORT_C CVPbkContactLinkArray *NewL()[static]

    Creates an empty link array.

    Returns: A new instance of this class

    NewLC ( )

    IMPORT_C CVPbkContactLinkArray *NewLC()[static]

    Creates an empty link array. Leaves the created array object on the cleanup stack.

    Returns: A new instance of this class

    NewLC ( const TDesC8 &, const MVPbkContactStoreList & )

    IMPORT_C CVPbkContactLinkArray *NewLC(const TDesC8 &aPackedLinks,
    const MVPbkContactStoreList &aStoreList
    )[static]

    Creates a link array from a packed descriptor of links.

    ParameterDescription
    aPackedLinksa buffer that was created using PackLC of MVPbkContactLinkArray or MVPbkContactLink
    aStoreListthe list of stores that contain the stores that links belong.

    Returns: A new instance of this class

    NewLC ( RReadStream &, const MVPbkContactStoreList & )

    IMPORT_C CVPbkContactLinkArray *NewLC(RReadStream &aStream,
    const MVPbkContactStoreList &aStoreList
    )[static]

    Creates a link array from a stream of links.

    ParameterDescription
    aStreama stream of contact link that was created using MVPbkStreamable interface of MVPbkContactLink
    aStoreListthe list of stores that contain the stores that links belong.

    Returns: A new instance of this class

    NewLC ( RReadStream &, MVPbkContactStoreLoader & )

    CVPbkContactLinkArray *NewLC(RReadStream &aStream,
    MVPbkContactStoreLoader &aLoader
    )[static]

    Creates a link array from a stream of links. Uses aLoader to find and load stores. aLoader must exist the life time of this object.

    ParameterDescription
    aStreama stream of contact link that was created using MVPbkStreamable interface of MVPbkContactLink
    aLoaderthe contact store loader for internalization.

    Returns: A new instance of this class

    PackLC ( )

    HBufC8 *PackLC()const

    PackedBufferSize ( )

    IMPORT_C TIntPackedBufferSize()const

    Returns the size of the packed link array

    Remove ( TInt )

    IMPORT_C voidRemove(TIntaIndex)

    Removes a link at aIndex from this array.

    Pre-condition
    aIndex >= 0 && aIndex <= Count()
    Post-condition
    The array count is decreased by one.

    Reset ( )

    IMPORT_C voidReset()

    Resets this array but doesn't destroy links

    Post-condition
    Count() == 0

    ResetAndDestroy ( )

    IMPORT_C voidResetAndDestroy()

    Resets the array and destroys the links

    Streamable ( )

    const MVPbkStreamable *Streamable()const
    © Nokia 2011.