CVPbkContactStoreUriArray Class Reference

#include <app/CVPbkContactStoreUriArray.h>

class CVPbkContactStoreUriArray : public CBase

Inherits from

CVPbkContactStoreUriArray

Public Member Functions
	~CVPbkContactStoreUriArray()
IMPORT_C void	AppendAllL(const CVPbkContactStoreUriArray &)
IMPORT_C void	AppendL(const TVPbkContactStoreUriPtr &)
IMPORT_C TInt	Count()
IMPORT_C TBool	IsIncluded(const TVPbkContactStoreUriPtr &)
IMPORT_C CVPbkContactStoreUriArray *	NewL()
IMPORT_C CVPbkContactStoreUriArray *	NewLC()
IMPORT_C CVPbkContactStoreUriArray *	NewLC(const TDesC8 &)
IMPORT_C HBufC8 *	PackLC()
IMPORT_C void	Remove(const TVPbkContactStoreUriPtr &)
IMPORT_C TVPbkContactStoreUriPtr	operator[](TInt)

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

Virtual Phonebook contact store URI array. Responsible for implementing a container for contact store URI's. In addition to common container behaviour the class can internalize and externalize store URI's from and to descriptors.

Constructor & Destructor Documentation

~CVPbkContactStoreUriArray ( )

~CVPbkContactStoreUriArray

(

)

Destructor.

Member Function Documentation

AppendAllL ( const CVPbkContactStoreUriArray & )

IMPORT_C void

AppendAllL

(

const CVPbkContactStoreUriArray &

aUriArray

)

Appends array of StoreUriPtr to this array.

Parameter	Description
aUriArray	Array of Store URIs to add array.

AppendL ( const TVPbkContactStoreUriPtr & )

IMPORT_C void

AppendL

(

const TVPbkContactStoreUriPtr &

aStoreUri

)

Appends StoreUriPtr to this array.

Parameter	Description
aStoreUri	Store URI to add array.

Count ( )

IMPORT_C TInt

Count

(

)

const

Returns the count of Store URIs in this array.

Returns: Count of Store URIs in array.

IsIncluded ( const TVPbkContactStoreUriPtr & )

IMPORT_C TBool

IsIncluded

(

const TVPbkContactStoreUriPtr &

aStoreUri

)

const

Checks whether the given URI is already in this array.

Parameter	Description
aStoreUri	Store URI to check.

Returns: ETrue if Store URI is in this array, EFalse if not.

NewL ( )

IMPORT_C CVPbkContactStoreUriArray *

NewL

(

)

[static]

Creates a new instance of this class.

Returns: Newly created instance of this class.

NewLC ( )

IMPORT_C CVPbkContactStoreUriArray *

NewLC

(

)

[static]

Creates a new instance of this class. Leaves the instance to the cleanup stack.

Returns: Newly created instance of this class.

NewLC ( const TDesC8 & )

IMPORT_C CVPbkContactStoreUriArray *

NewLC

(

const TDesC8 &

aPackedUris

)

[static]

Creates a new instance of this class internalizing the contents of the descriptor.

Parameter	Description
aPackedUris	Packed URIs created by using the PackLC functionality of this class.

Returns: Newly created instance of this class.

PackLC ( )

IMPORT_C HBufC8 *

PackLC

(

)

const

Packs this URI array to a heap descriptor.

Returns: Packed URI array in a heap descriptor.

Remove ( const TVPbkContactStoreUriPtr & )

IMPORT_C void

Remove

(

const TVPbkContactStoreUriPtr &

aStoreUri

)

Removes StoreUriPtr from this array.

Parameter	Description
aStoreUri	Store Uri to add array.

operator[] ( TInt )

IMPORT_C TVPbkContactStoreUriPtr

operator[]

(

TInt

aIndex

)

const

Gets the URI pointer descriptor from this array at the given index.

Parameter	Description
aIndex	Index which URI Ptr is needed

Returns: URI pointer descriptor.