Collapse all Symbian^3 Application Developer Library

MMTPReferenceMgr Class Reference

class MMTPReferenceMgr

Defines the MTP data provider framework object reference manager interface.

Public Member Functions
CMTPTypeArray *	ReferencesLC (const TMTPTypeUint32 &)
CDesCArray *	ReferencesLC (const TDesC &)
void	RemoveReferencesL (const TDesC &)
void	SetReferenceL (const TDesC &, const TDesC &)
void	SetReferencesL (const TDesC &, const CDesCArray &)
void	SetReferencesL (const TMTPTypeUint32 &, const CMTPTypeArray &)

Member Functions Documentation

ReferencesLC(const TMTPTypeUint32 &)

CMTPTypeArray *

ReferencesLC

(

const TMTPTypeUint32 &

aFromHandle

)

const [pure virtual]

Provides an MTP array of the target object handles which are referenced by the specified source object handle. A pointer to the MTP array is placed on the cleanup stack.

leave: One of the system wide error codes, if a processing failure occurs.

Parameters

const TMTPTypeUint32 & aFromHandle

The MTP object handle of the source object from which the references originate.

ReferencesLC(const TDesC &)

CDesCArray *

ReferencesLC

(

const TDesC &

aParentSuid

)

const [pure virtual]

Provides an SUID array of the target object SUIDs which are referenced by the specified source object SUID. A pointer to the SUID array is placed on the cleanup stack.

leave: One of the system wide error codes, if a processing failure occurs.

Parameters

const TDesC & aParentSuid

RemoveReferencesL(const TDesC &)

void

RemoveReferencesL

(

const TDesC &

aSuid

)

[pure virtual]

Removes all object reference links in which the specified SUID represents either the source or target reference object.

leave: One of the system wide error codes, if a processing failure occurs.

Parameters

const TDesC & aSuid

The object SUID.

SetReferenceL(const TDesC &, const TDesC &)

void	SetReferenceL	(	const TDesC &	aFromSuid,
			const TDesC &	aToSuid
		)	[pure virtual]

Creates an abstract reference linkage between the specified source and target object SUIDs.

leave: One of the system wide error codes, if a processing failure occurs.

Parameters

const TDesC & aFromSuid	The SUID of the source object from which the reference originates.
const TDesC & aToSuid	The SUID of the target object to which the reference is made.

SetReferencesL(const TDesC &, const CDesCArray &)

void	SetReferencesL	(	const TDesC &	aFromSuid,
			const CDesCArray &	aToSuids
		)	[pure virtual]

Replaces the abstract reference links originating from the specified source object SUID with the specified set of target object SUIDs.

leave: One of the system wide error codes, if a processing failure occurs.

Parameters

const TDesC & aFromSuid	The SUID of the source object from which the references originate.
const CDesCArray & aToSuids	The reference target object SUID array.

SetReferencesL(const TMTPTypeUint32 &, const CMTPTypeArray &)

void	SetReferencesL	(	const TMTPTypeUint32 &	aFromHandle,
			const CMTPTypeArray &	aToHandles
		)	[pure virtual]

Replaces the abstract reference links originating from the specified source object handle with the specified set of target object handles.

leave: One of the system wide error codes, if a processing failure occurs.

Parameters

const TMTPTypeUint32 & aFromHandle	The MTP object handle of the source object from which the references originate.
const CMTPTypeArray & aToHandles	The reference target MTP object handle array.