Collapse all Symbian^3 Product Developer Library

MMTPObjectMgr Class Reference

class MMTPObjectMgr

Defines the MTP data provider framework object store enumeration manager interface.

Public Member Functions
void	CommitReservedObjectHandleL(CMTPObjectMetaData &)
TUint	CountL(const TMTPObjectMgrQueryParams &)
void	GetObjectHandlesL(const TMTPObjectMgrQueryParams &, RMTPObjectMgrQueryContext &, RArray< TUint > &)
void	GetObjectSuidsL(const TMTPObjectMgrQueryParams &, RMTPObjectMgrQueryContext &, CDesCArray &)
TUint32	HandleL(const TDesC &)
void	InsertObjectL(CMTPObjectMetaData &)
void	InsertObjectsL(RPointerArray< CMTPObjectMetaData > &)
void	ModifyObjectL(const CMTPObjectMetaData &)
TAny *	MtpDeltaDataMgr()
TBool	ObjectL(const TMTPTypeUint32 &, CMTPObjectMetaData &)
TBool	ObjectL(const TDesC &, CMTPObjectMetaData &)
TUint	ObjectOwnerId(const TMTPTypeUint32 &)
TMTPTypeUint128	PuidL(TUint32)
TMTPTypeUint128	PuidL(TInt64)
TMTPTypeUint128	PuidL(const TDesC &)
void	RemoveObjectL(const TMTPTypeUint32 &)
void	RemoveObjectL(const TDesC &)
void	RemoveObjectsL(const CDesCArray &)
void	RemoveObjectsL(TUint)
void	ReserveObjectHandleL(CMTPObjectMetaData &, TUint64)
void	UnreserveObjectHandleL(const CMTPObjectMetaData &)

Member Functions Documentation

CommitReservedObjectHandleL(CMTPObjectMetaData &)

void

CommitReservedObjectHandleL

(

CMTPObjectMetaData &

aObject

)

[pure virtual]

Commits into MTP data object enumeration store the object handle and storage space previously reserved for the specified object. This is typically used when either an MTP SendObjectInfo/SendObject, or SendObjectPropList/SendObject operation sequence has completed successfully.

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

ReserveObjectHandleL

Parameters

CMTPObjectMetaData & aObject

The MTP data object information record to be commited.

CountL(const TMTPObjectMgrQueryParams &)

TUint

CountL

(

const TMTPObjectMgrQueryParams &

aParams

)

const [pure virtual]

Provides a count of the number of object meta data records present in the MTP data object enumeration store. This query can be targeted at specific storage media and/or object data formats, or can be used to query all MTP data objects on the device.

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

Parameters

const TMTPObjectMgrQueryParams & aParams

The query parameters.

GetObjectHandlesL(const TMTPObjectMgrQueryParams &, RMTPObjectMgrQueryContext &, RArray< TUint > &)

void	GetObjectHandlesL	(	const TMTPObjectMgrQueryParams &	aParams,
			RMTPObjectMgrQueryContext &	aContext,
			RArray< TUint > &	aHandles
		)	const [pure virtual]

Provides an array of object handles present in the MTP data object enumeration store. This query can be targeted at specific storage media and/or object data formats, or can be used to query all MTP data objects on the device.

Depending on the query parameter specified, this query may incur significant RAM consumption, and so is intended to be called repeatedly in order to retrieve all matching SUID data. On completion, aContext can be used to determine if there is more data to be retrieved.If there are no object handles which match the specified parameters then a zero length SUID array is provided.

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

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

Parameters

const TMTPObjectMgrQueryParams & aParams	The query parameters.
RMTPObjectMgrQueryContext & aContext	The query context data. On completion this data indicates if there are additional object handle data to retrieve.
RArray< TUint > & aHandles	The MTP object handles array buffer to be populated.

GetObjectSuidsL(const TMTPObjectMgrQueryParams &, RMTPObjectMgrQueryContext &, CDesCArray &)

void	GetObjectSuidsL	(	const TMTPObjectMgrQueryParams &	aParams,
			RMTPObjectMgrQueryContext &	aContext,
			CDesCArray &	aSuids
		)	const [pure virtual]

Provides an array of object SUIDs present in the MTP data object enumeration store. This query can be targeted at specific storage media and/or object data formats, or can be used to query all MTP data objects on the device.

Depending on the query parameter specified, this query may incur significant RAM consumption, and so is intended to be called repeatedly in order to retrieve all matching object SUID data. On completion, aContext can be used to determine if there is more data to be retrieved.If there are no object handles which match the specified parameters then a zero length SUID array is provided.

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

Parameters

const TMTPObjectMgrQueryParams & aParams	The query parameters.
RMTPObjectMgrQueryContext & aContext	The query context data. On completion this data indicates if there are additional SUID data to retrieve.
CDesCArray & aSuids	The object SUIDs array buffer to be populated.

HandleL(const TDesC &)

TUint32

HandleL

(

const TDesC &

aSuid

)

const [pure virtual]

Provides the MTP object handle of the object with the specified specified System Unique Identifier (SUID).

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

Parameters

const TDesC & aSuid

The object SUID.

InsertObjectL(CMTPObjectMetaData &)

void

InsertObjectL

(

CMTPObjectMetaData &

aObject

)

[pure virtual]

Inserts a single object information record into the MTP data object enumeration store. A unique MTP object handle is assigned to the data object.

leave: KErrAlreadyExists, if an object with the specified MTP object SUID already exists in the MTP data object enumeration store.

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

Parameters

CMTPObjectMetaData & aObject

The MTP data object information record to be inserted.

InsertObjectsL(RPointerArray< CMTPObjectMetaData > &)

void

InsertObjectsL

(

RPointerArray< CMTPObjectMetaData > &

aObjects

)

[pure virtual]

Inserts multiple object meta data records in the MTP data object enumeration store. A unique MTP object handle is assigned to each of the data objects.

leave: KErrAlreadyExists, if an object with the one of the specified MTP object SUIDs already exists in the MTP data object enumeration store. already exists in the MTP data object enumeration store.

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

Parameters

RPointerArray< CMTPObjectMetaData > & aObjects

The MTP data object meta data records to be inserted.

ModifyObjectL(const CMTPObjectMetaData &)

void

ModifyObjectL

(

const CMTPObjectMetaData &

aObject

)

[pure virtual]

Modifies the specified MTP data object's object information record.

Parameters

const CMTPObjectMetaData & aObject

The modified MTP data object information record values.

MtpDeltaDataMgr()

TAny *

MtpDeltaDataMgr

(

)

[inline, virtual]

Get MtpDeltaDataMgr

ObjectL(const TMTPTypeUint32 &, CMTPObjectMetaData &)

TBool	ObjectL	(	const TMTPTypeUint32 &	aHandle,
			CMTPObjectMetaData &	aObject
		)	const [pure virtual]

Provides either the object information record associated with the associated MTP object handle, or provides an indication that the specified object handle does not exist.

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

Parameters

const TMTPTypeUint32 & aHandle	The MTP object handle associated with the object information record to be provided.
CMTPObjectMetaData & aObject	On exit, the object information record of the requested object.

ObjectL(const TDesC &, CMTPObjectMetaData &)

TBool	ObjectL	(	const TDesC &	aSuid,
			CMTPObjectMetaData &	aObject
		)	const [pure virtual]

Provides the object information record associated with the associated MTP object SUID, or provides an indication that the specified object handle does not exist.

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

Parameters

const TDesC & aSuid	The MTP object SUID associated with the object information record to be provided.
CMTPObjectMetaData & aObject	On exit, the object information record of the requested object.

ObjectOwnerId(const TMTPTypeUint32 &)

RemoveObjectsL

(

TUint

aDataProviderId

)

[pure virtual]

Removes from the MTP data object enumeration store all object meta data records owned by the specified data provider.

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

Parameters

TUint aDataProviderId

The ID of the data provider owning the object meta data records to be deleted.

ReserveObjectHandleL(CMTPObjectMetaData &, TUint64)

void	ReserveObjectHandleL	(	CMTPObjectMetaData &	aObject,
			TUint64	aSpaceRequired
		)	[pure virtual]

Reserves space for and assigns an object handle to the object described by the specified object information record. This is typically used when processing MTP SendObjectInfo or SendObjectPropList operations.

leave: KErrTooBig, if aSpaceRequired exceeds the available capacity of the storage.

leave: KErrOverflow, if an object handle cannot be assigned.

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

CommitReservedObjectL UnReserveObjectHandleL

Parameters

CMTPObjectMetaData & aObject	The object information record of the object. On successful completion this is updated with the assigned object handle.
TUint64 aSpaceRequired	The storage space to be reserved for the object.

UnreserveObjectHandleL(const CMTPObjectMetaData &)

void

UnreserveObjectHandleL

(

const CMTPObjectMetaData &

aObject

)

[pure virtual]

Releases the object handle and storage space previously reserved for the specified object. This is typically used when either an MTP SendObjectInfo/SendObject, or SendObjectPropList/SendObject operation sequence has not completed successfully.

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

ReserveObjectHandleL

Parameters

const CMTPObjectMetaData & aObject

The MTP data object information record of the object.