XmlEngXPathConfiguration Class Reference

#include <xml/dom/xmlengxpathconfiguration.h>

class XmlEngXPathConfiguration
Public Member Functions
IMPORT_C voidAddExtensionFunctionL(const TXmlEngExtensionFunctionDescriptor &)
IMPORT_C voidAddExtensionFunctionVectorL(const RArray< TXmlEngExtensionFunctionDescriptor > &, TUint)
IMPORT_C voidAddNativeExtensionFunctionL(const TXmlEngExtensionFunctionDescriptor &)
IMPORT_C voidAddNativeExtensionFunctionVectorL(const RArray< TXmlEngExtensionFunctionDescriptor > &, TUint)
IMPORT_C TBoolIsFunctionSupportedL(const TDesC8 &, const TDesC8 &)
IMPORT_C voidRemoveExtensionFunction(const TXmlEngExtensionFunctionDescriptor &)
IMPORT_C voidRemoveExtensionFunctionVector(const RArray< TXmlEngExtensionFunctionDescriptor > &, TUint)
IMPORT_C voidResetExtensionFunctionsL()
IMPORT_C voidUnused_Func1(TBool)

Detailed Description

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.

See also: MXmlEngXPathExtensionFunction MXmlEngXPathEvaluationContext TXmlEngExtensionFunctionDescriptor

Member Function Documentation

AddExtensionFunctionL ( const TXmlEngExtensionFunctionDescriptor & )

IMPORT_C voidAddExtensionFunctionL(const TXmlEngExtensionFunctionDescriptor &aFuncDes)[static]

Registers an extension function at the global scope.

Parameters
aFuncDesFunction descriptor.
Leave Codes
KXmlEngErrWrongUseOfAPIError initializing XPath context
KXmlEngErrXPathResultError adding function

AddExtensionFunctionVectorL ( const RArray< TXmlEngExtensionFunctionDescriptor > &, TUint )

IMPORT_C voidAddExtensionFunctionVectorL(const RArray< TXmlEngExtensionFunctionDescriptor > &aFuncVector,
TUintaSize
)[static]

Registers a set of extension functions at the global scope.

Parameters
aFuncVectorVector with function descriptors. Ownership is not transferred.
aSizeThe size of the vector
Leave Codes
KXmlEngErrWrongUseOfAPIError initializing XPath context
KXmlEngErrXPathResultError adding function

AddNativeExtensionFunctionL ( const TXmlEngExtensionFunctionDescriptor & )

IMPORT_C voidAddNativeExtensionFunctionL(const TXmlEngExtensionFunctionDescriptor &aNativeFuncDes)[static]

Registers a native extension function at the global scope.

Parameters
aNativeFuncDesFunction descriptor.
Leave Codes
KXmlEngErrWrongUseOfAPIError initializing XPath context
KXmlEngErrXPathResultError adding function

AddNativeExtensionFunctionVectorL ( const RArray< TXmlEngExtensionFunctionDescriptor > &, TUint )

IMPORT_C voidAddNativeExtensionFunctionVectorL(const RArray< TXmlEngExtensionFunctionDescriptor > &aNativeFuncVector,
TUintaSize
)[static]

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

Parameters
aNativeFuncVectorFunction descriptor.
aSizeThe size of the vector
Leave Codes
KXmlEngErrWrongUseOfAPIError initializing XPath context
KXmlEngErrXPathResultError adding function

IsFunctionSupportedL ( const TDesC8 &, const TDesC8 & )

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

Check if XPath extension function is supported.

Parameters
aFuncFunction name
aNsUriFunction namespace URI
Return Value
ETrue if supported, EFalse otherwise
Leave Codes

RemoveExtensionFunction ( const TXmlEngExtensionFunctionDescriptor & )

IMPORT_C voidRemoveExtensionFunction(const TXmlEngExtensionFunctionDescriptor &aFuncDes)[static]

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

Parameters
aFuncDesFunction descriptor.

RemoveExtensionFunctionVector ( const RArray< TXmlEngExtensionFunctionDescriptor > &, TUint )

IMPORT_C voidRemoveExtensionFunctionVector(const RArray< TXmlEngExtensionFunctionDescriptor > &aFuncVector,
TUintaSize
)[static]

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

Parameters
aFuncVectorVector with function descriptors.
aSizeThe size of the vector

ResetExtensionFunctionsL ( )

IMPORT_C voidResetExtensionFunctionsL()[static]
Disables support of any previously registered extension functions and switches to support only the XPath Function Library.
Leave Codes
KErrNoMemoryMemory allocation failure

Unused_Func1 ( TBool )

IMPORT_C voidUnused_Func1(TBoolaEnable)[static]

Unused

© Nokia 2005.