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

Constructor & Destructor Documentation

TVPbkContactStoreUriPtr(const TDesC &)

IMPORT_CTVPbkContactStoreUriPtr(const TDesC &aStoreUri)

Constructs a URI pointer to aStoreUri.

Parameters

const TDesC & aStoreUriA reference to the contact store URI.

TVPbkContactStoreUriPtr()

IMPORT_CTVPbkContactStoreUriPtr()

Constructor.

Member Functions Documentation

Compare(const TVPbkContactStoreUriPtr &, TVPbkContactStoreUriComponent)

IMPORT_C TIntCompare(const TVPbkContactStoreUriPtr &aUri,
TVPbkContactStoreUriComponentaComponent
)const

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

Zero if the URIs are the same.

Parameters

const TVPbkContactStoreUriPtr & aUriThe URI whose component is compared.
TVPbkContactStoreUriComponent aComponentDefines the component that are compared.

Compare(const TDesC &, TVPbkContactStoreUriComponent)

IMPORT_C TIntCompare(const TDesC &aUriComponent,
TVPbkContactStoreUriComponentaComponent
)const

Compares this URI's component to aUriComponent.

Zero if components matched.

Parameters

const TDesC & aUriComponentA descriptor that contains the component data.
TVPbkContactStoreUriComponent aComponentDefines 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 TPtrCComponent(TVPbkContactStoreUriComponentaComponent)const

Returns a pointer to the aComponent part of URI.

a pointer to the aComponent part of URI.

Parameters

TVPbkContactStoreUriComponent aComponentDefines the component that is returned.

ExternalizeL(RWriteStream &)

IMPORT_C voidExternalizeL(RWriteStream &aStream)const [virtual]

Outputs this objects state to aStream.

Parameters

RWriteStream & aStreamA stream for writing the object state.

ExternalizedSize()

IMPORT_C TIntExternalizedSize()const [virtual]

Returns the externalized size of the object in bytes.

The externalized size of the object.

Length()

IMPORT_C TIntLength()const

Returns the length of the URI.

The length of the URI.

Set(const TVPbkContactStoreUriPtr &)

IMPORT_C voidSet(const TVPbkContactStoreUriPtr &aUri)

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

Parameters

const TVPbkContactStoreUriPtr & aUriThe URI that will be pointed to.

UriDes()

IMPORT_C const TDesC &UriDes()const

Returns a descriptor that holds the whole Uri.

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]