TVPbkContactStoreUriPtr Class Reference

#include <app/TVPbkContactStoreUriPtr.h>

Link against: VPbkEng.lib

class TVPbkContactStoreUriPtr : public MVPbkStreamable

Inherits from

TVPbkContactStoreUriPtr
- MVPbkStreamable

Public Member Enumerations
enum	TVPbkContactStoreUriComponent { EContactStoreUriAllComponents, EContactStoreUriStoreType, EContactStoreUriStoreDrive, EContactStoreUriStoreLocation }

Public Member Functions
	TVPbkContactStoreUriPtr(const TDesC &)
	TVPbkContactStoreUriPtr()
IMPORT_C TInt	Compare(const TVPbkContactStoreUriPtr &, TVPbkContactStoreUriComponent)
IMPORT_C TInt	Compare(const TDesC &, TVPbkContactStoreUriComponent)
IMPORT_C const TPtrC	Component(TVPbkContactStoreUriComponent)
virtual IMPORT_C void	ExternalizeL(RWriteStream &)
virtual IMPORT_C TInt	ExternalizedSize()
IMPORT_C TInt	Length()
IMPORT_C void	Set(const TVPbkContactStoreUriPtr &)
IMPORT_C const TDesC &	UriDes()

Inherited Functions
	MVPbkStreamable::StreamableExtension(TUid)
	MVPbkStreamable::~MVPbkStreamable()

Detailed Description

A class for using contact store URIs (Uniform Resource Identifier).

A URI identifies a contact store. This class is a helper for accessing URI data. It can be used to separate the different parts of the URI and compare URIs.

E.g. A URI of the store could be cntdb://c:contacts.cdb. This URI have three components: 1) cntdb is a scheme - EContactStoreUriStoreType 2) c is a drive of the database - EContactStoreUriStoreDrive 3) c:contacts.cdb is the location - EContactStoreUriStoreLocation

Member Enumeration Documentation

Enum TVPbkContactStoreUriComponent

URI component types.

Enumerator	Value	Description
EContactStoreUriAllComponents		the whole URI
EContactStoreUriStoreType		the stores type, the URI's scheme
EContactStoreUriStoreDrive		the stores drive letter
EContactStoreUriStoreLocation		the stores file/host location

Constructor & Destructor Documentation

TVPbkContactStoreUriPtr ( const TDesC & )

IMPORT_C

TVPbkContactStoreUriPtr

(

const TDesC &

aStoreUri

)

Constructs a URI pointer to aStoreUri.

Parameter	Description
aStoreUri	A reference to the contact store URI.

TVPbkContactStoreUriPtr ( )

IMPORT_C

TVPbkContactStoreUriPtr

(

)

Constructor.

Member Function Documentation

Compare ( const TVPbkContactStoreUriPtr &, TVPbkContactStoreUriComponent )

IMPORT_C TInt	Compare	(	const TVPbkContactStoreUriPtr &	aUri,
			TVPbkContactStoreUriComponent	aComponent
		)	const

Compares this URI's component to aUri's component.

Parameter	Description
aUri	The URI whose component is compared.
aComponent	Defines the component that are compared.

Returns: Zero if the URIs are the same.

Compare ( const TDesC &, TVPbkContactStoreUriComponent )

IMPORT_C TInt	Compare	(	const TDesC &	aUriComponent,
			TVPbkContactStoreUriComponent	aComponent
		)	const

Compares this URI's component to aUriComponent.

Parameter	Description
aUriComponent	A descriptor that contains the component data.
aComponent	Defines the component of this URI that is compared to aUriComponent.

Returns: Zero if components matched.

Component ( TVPbkContactStoreUriComponent )

IMPORT_C const TPtrC

Component

(

TVPbkContactStoreUriComponent

aComponent

)

const

Returns a pointer to the aComponent part of URI.

Parameter	Description
aComponent	Defines the component that is returned.

Returns: a pointer to the aComponent part of URI.

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const [virtual]

Reimplemented from MVPbkStreamable::ExternalizeL(RWriteStream &)const

Outputs this objects state to aStream.

Parameter	Description
aStream	A stream for writing the object state.

ExternalizedSize ( )

IMPORT_C TInt

ExternalizedSize

(

)

const [virtual]

Reimplemented from MVPbkStreamable::ExternalizedSize()const

Returns the externalized size of the object in bytes.

Returns: The externalized size of the object.

Length ( )

IMPORT_C TInt

Length

(

)

const

Returns the length of the URI.

Returns: The length of the URI.

Set ( const TVPbkContactStoreUriPtr & )

IMPORT_C void

Set

(

const TVPbkContactStoreUriPtr &

aUri

)

Sets this URI pointer to point to the same URI as aUri.

Parameter	Description
aUri	The URI that will be pointed to.

UriDes ( )

IMPORT_C const TDesC &

UriDes

(

)

const

Returns a descriptor that holds the whole Uri.

Returns: A descriptor that holds the whole Uri.