Collapse all Symbian^3 Product Developer Library

TVPbkContactStoreUriPtr Class Reference

class TVPbkContactStoreUriPtr : public MVPbkStreamable

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

VPbkEng.lib

Inherits from

TVPbkContactStoreUriPtr
- MVPbkStreamable

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)
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C TInt	ExternalizedSize()
IMPORT_C TInt	Length()
IMPORT_C void	Set(const TVPbkContactStoreUriPtr &)
IMPORT_C const TDesC &	UriDes()

Private Member Functions
TInt	Compare(const TDesC &, const TDesC &)

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

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

Private Attributes
TAny *	iSpare
TPtrC	iUriBufferPointer

Constructor & Destructor Documentation

TVPbkContactStoreUriPtr(const TDesC &)

IMPORT_C

TVPbkContactStoreUriPtr

(

const TDesC &

aStoreUri

)

Constructs a URI pointer to aStoreUri.

Parameters

const TDesC & aStoreUri

A reference to the contact store URI.

TVPbkContactStoreUriPtr()

IMPORT_C

TVPbkContactStoreUriPtr

(

)

Constructor.

Member Functions Documentation

Compare(const TVPbkContactStoreUriPtr &, TVPbkContactStoreUriComponent)

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

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

Parameters

const TVPbkContactStoreUriPtr & aUri	The URI whose component is compared.
TVPbkContactStoreUriComponent aComponent	Defines the component that are compared.

Compare(const TDesC &, TVPbkContactStoreUriComponent)

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

Compares this URI's component to aUriComponent.

Parameters

const TDesC & aUriComponent	A descriptor that contains the component data.
TVPbkContactStoreUriComponent aComponent	Defines the component of this URI that is compared to aUriComponent.

Compare(const TDesC &, const TDesC &)

TInt	Compare	(	const TDesC &	aLhsUri,
			const TDesC &	aRhsUri
		)	const [private]

Parameters

const TDesC & aLhsUri
const TDesC & aRhsUri

Component(TVPbkContactStoreUriComponent)

IMPORT_C const TPtrC

Component

(

TVPbkContactStoreUriComponent

aComponent

)

const

Returns a pointer to the aComponent part of URI.

Parameters

TVPbkContactStoreUriComponent aComponent

Defines the component that is returned.

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const [virtual]

Outputs this objects state to aStream.

Parameters

RWriteStream & aStream

A stream for writing the object state.

ExternalizedSize()

IMPORT_C TInt

ExternalizedSize

(

)

const [virtual]

Returns the externalized size of the object in bytes.

Length()

IMPORT_C TInt

Length

(

)

const

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.

Parameters

const TVPbkContactStoreUriPtr & aUri

The URI that will be pointed to.

UriDes()

IMPORT_C const TDesC &

UriDes

(

)

const

Returns a descriptor that holds the whole Uri.

Member Enumerations Documentation

Enum TVPbkContactStoreUriComponent

URI component types.

Enumerators

EContactStoreUriAllComponents
EContactStoreUriStoreType
EContactStoreUriStoreDrive
EContactStoreUriStoreLocation

Member Data Documentation

TAny * iSpare

TAny *

iSpare

[private]

TPtrC iUriBufferPointer

TPtrC

iUriBufferPointer

[private]