XmlEngXPathConfiguration Class Reference

class XmlEngXPathConfiguration

This object is used to support extension functions used within the XPath library. Extension functions may be added or removed. This object can also determine whether an extension function is supported.

Extension functions are stored in a TXmlEngExtensionFunctionDescriptor object which holds the extension function (a MXmlEngXPathExtensionFunction instance), the function name and the function namespace. An extension function can be added to the library using XmlEngXPathConfiguration::AddExtensionFunctionL().

When an extension function is to be evaluated, MXmlEngXPathExtensionFunction::Evaluate() is called with a MXmlEngXPathEvaluationContext instance which holds the function arguments and evaluation result.

MXmlEngXPathExtensionFunction

MXmlEngXPathEvaluationContext

TXmlEngExtensionFunctionDescriptor

Public Member Functions
IMPORT_C void	AddExtensionFunctionL(const TXmlEngExtensionFunctionDescriptor &)
IMPORT_C void	AddExtensionFunctionVectorL(const RArray< TXmlEngExtensionFunctionDescriptor > &, TUint)
IMPORT_C void	AddNativeExtensionFunctionL(const TXmlEngExtensionFunctionDescriptor &)
IMPORT_C void	AddNativeExtensionFunctionVectorL(const RArray< TXmlEngExtensionFunctionDescriptor > &, TUint)
IMPORT_C TBool	IsFunctionSupportedL(const TDesC8 &, const TDesC8 &)
IMPORT_C void	RemoveExtensionFunction(const TXmlEngExtensionFunctionDescriptor &)
IMPORT_C void	RemoveExtensionFunctionVector(const RArray< TXmlEngExtensionFunctionDescriptor > &, TUint)
IMPORT_C void	ResetExtensionFunctionsL()
IMPORT_C void	Unused_Func1(TBool)

Member Functions Documentation

AddExtensionFunctionL(const TXmlEngExtensionFunctionDescriptor &)

IMPORT_C void

AddExtensionFunctionL

(

const TXmlEngExtensionFunctionDescriptor &

aFuncDes

)

[static]

Registers an extension function at the global scope.

leave

KXmlEngErrWrongUseOfAPI Error initializing XPath context

leave

KXmlEngErrXPathResult Error adding function

leave

One of the system-wide error codes

Parameters

const TXmlEngExtensionFunctionDescriptor & aFuncDes

Function descriptor.

AddExtensionFunctionVectorL(const RArray< TXmlEngExtensionFunctionDescriptor > &, TUint)

IMPORT_C void	AddExtensionFunctionVectorL	(	const RArray< TXmlEngExtensionFunctionDescriptor > &	aFuncVector,
			TUint	aSize
		)	[static]

Registers a set of extension functions at the global scope.

leave

KXmlEngErrWrongUseOfAPI Error initializing XPath context

leave

KXmlEngErrXPathResult Error adding function

leave

One of the system-wide error codes

Parameters

const RArray< TXmlEngExtensionFunctionDescriptor > & aFuncVector	Vector with function descriptors. Ownership is not transferred.
TUint aSize	The size of the vector

AddNativeExtensionFunctionL(const TXmlEngExtensionFunctionDescriptor &)

IMPORT_C void

AddNativeExtensionFunctionL

(

const TXmlEngExtensionFunctionDescriptor &

aNativeFuncDes

)

[static]

Registers a native extension function at the global scope.

leave

KXmlEngErrWrongUseOfAPI Error initializing XPath context

leave

KXmlEngErrXPathResult Error adding function

leave

One of the system-wide error codes

Parameters

const TXmlEngExtensionFunctionDescriptor & aNativeFuncDes

Function descriptor.

AddNativeExtensionFunctionVectorL(const RArray< TXmlEngExtensionFunctionDescriptor > &, TUint)

IMPORT_C void	AddNativeExtensionFunctionVectorL	(	const RArray< TXmlEngExtensionFunctionDescriptor > &	aNativeFuncVector,
			TUint	aSize
		)	[static]

Registers a set of native extension functions at the global scope.

leave

KXmlEngErrWrongUseOfAPI Error initializing XPath context

leave

KXmlEngErrXPathResult Error adding function

leave

One of the system-wide error codes

Parameters

const RArray< TXmlEngExtensionFunctionDescriptor > & aNativeFuncVector	Function descriptor.
TUint aSize	The size of the vector

IsFunctionSupportedL(const TDesC8 &, const TDesC8 &)

IMPORT_C TBool	IsFunctionSupportedL	(	const TDesC8 &	aFunc,
			const TDesC8 &	aNsUri
		)	[static]

Check if XPath extension function is supported.

ETrue if supported, EFalse otherwise

leave

One of the system-wide error codes

Parameters

const TDesC8 & aFunc	Function name
const TDesC8 & aNsUri	Function namespace URI

RemoveExtensionFunction(const TXmlEngExtensionFunctionDescriptor &)

IMPORT_C void

RemoveExtensionFunction

(

const TXmlEngExtensionFunctionDescriptor &

aFuncDes

)

[static]

Deregisters an extension function. No error is generated if the extension function is not found.

Parameters

const TXmlEngExtensionFunctionDescriptor & aFuncDes

Function descriptor.

RemoveExtensionFunctionVector(const RArray< TXmlEngExtensionFunctionDescriptor > &, TUint)

IMPORT_C void	RemoveExtensionFunctionVector	(	const RArray< TXmlEngExtensionFunctionDescriptor > &	aFuncVector,
			TUint	aSize
		)	[static]

Deregisters a set of extension functions. No error is generated if an extension function in the vector is not found.

Parameters

const RArray< TXmlEngExtensionFunctionDescriptor > & aFuncVector	Vector with function descriptors.
TUint aSize	The size of the vector

ResetExtensionFunctionsL()

IMPORT_C void

ResetExtensionFunctionsL

(

)

[static]

Disables support of any previously registered extension functions and switches to support only the XPath Function Library. leave

KErrNoMemory Memory allocation failure

Unused_Func1(TBool)

IMPORT_C void

Unused_Func1

(

TBool

aEnable

)

[static]

Unused

Parameters

TBool aEnable