Collapse all Symbian^3 Application Developer Library

MMTPDataProviderConfig Class Reference

class MMTPDataProviderConfig

Defines the data provider configurability parameter interface.

Public Member Functions
TBool	BoolValue ( TParameter )
const TDesC8 &	DesC8Value ( TParameter )
const TDesC &	DesCValue ( TParameter )
void	GetArrayValue ( TParameter , RArray < TUint > &)
TUint	UintValue ( TParameter )

Public Member Enumerations
enum	TParameter { EDataProviderType , EMajorProtocolRevision , EObjectEnumerationPersistent , ESupportedModes , EServerName , EServerImageName , EOpaqueResource , EResourceFileName , EEnumerationPhase }

Member Functions Documentation

BoolValue(TParameter)

TBool

BoolValue

(

TParameter

aParam

)

const [pure virtual]

Provides the specified TBool parameter value.

panic: USER 0, if the parameter data type is not

TBool .

Parameters

TParameter aParam

The parameter value to retrieve.

DesC8Value(TParameter)

const TDesC8 &

DesC8Value

(

TParameter

aParam

)

const [pure virtual]

Provides the specified TDesC8 parameter value.

panic: USER 0, if the parameter data type is not

TDesC8 .

Parameters

TParameter aParam

The parameter value to retrieve.

DesCValue(TParameter)

const TDesC &

DesCValue

(

TParameter

aParam

)

const [pure virtual]

Provides the specified TDesC parameter value.

panic: USER 0, if the parameter data type is not

TDesC .

Parameters

TParameter aParam

The parameter value to retrieve.

GetArrayValue(TParameter, RArray< TUint > &)

void	GetArrayValue	(	TParameter	aParam,
			RArray < TUint > &	aArray
		)	const [pure virtual]

Retrieves the specified RArray<TUint> parameter value.

panic: USER 0, if the parameter data type is not

RArray<TUint> .

Parameters

TParameter aParam	The parameter value to retrieve.
RArray < TUint > & aArray

UintValue(TParameter)

TUint

UintValue

(

TParameter

aParam

)

const [pure virtual]

Provides the specified TUint parameter value.

panic: USER 0, if the parameter data type is not

TUint .

Parameters

TParameter aParam

The parameter value to retrieve.

Member Enumerations Documentation

Enum TParameter

Defines the data provider configurability parameters.

Enumerators

EDataProviderType	This parameter specifies the type of the data provider which in turn determines how it will be loaded. The set of valid parameter values is defined by the TMTPDataProviderType enumeration.This parameter value can be accessed using the UintValue API.
EMajorProtocolRevision	This parameter specifies the highest major MTP protocol revision supported by the data provider. MTP protocol revision identifiers take the form N.N, of which the major protocol revision comprises the most significant digit(s) to the left of the period (.), e.g. a major protocol version value of 1 would represent all MTP protocol revisions from 1.0 up to (but not including) 2.0. This parameter value can be accessed using the UintValue API.
EObjectEnumerationPersistent	This parameter indicates whether the object enumerations which the data provider registers with the MTP object manager should persist when the data provider is unloaded from the MTP framework. If the persistent option is selected, then on each subsequent activation after its initial object store enumeration is complete the data provider will be required to re-enumerate only that portion of its object store which has changed (objects added, removed, or modified) since it was last loaded. If the persistent option is not selected, then the data provider will be required to re-enumerate its entire object store each time it is loaded. This parameter value can be accessed using the BoolValue API
ESupportedModes	This parameter specifies the modes of operation which the data provider supports. It is specified as an integer which encodes a set of bit flags. The set of valid bit flag values is defined by the TMTPMode enumeration.The set of parameter values can be accessed using the GetArrayValue API.
EServerName	This parameter is reserved for future use.
EServerImageName	This parameter is reserved for future use.
EOpaqueResource	This parameter specifies an optional configuration data resource whose form and function is specific to the data provider. The parameter value is specified as an LLINK resource and can be accessed using the DesC8Value API.
EResourceFileName	This parameter specifies the resource filename in which the set of data provider configurability parameter values are specified. The set of parameter values can be accessed using the DesCValue API.
EEnumerationPhase	This parameter specifies the enumeration phase of the data provider This parameter value can be accessed using the UintValue API.