Class XmlExternalFunction

The XmlExternalFunction class is used to implement XQuery extension functions in .NET Framework languages.

Inheritance
System.Object
XmlExternalFunction
Implements
System.IDisposable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Figaro
Assembly: Figaro.dll
Syntax
public abstract class XmlExternalFunction : IDisposable
Remarks

An implementor creates one or more subclasses of XmlExternalFunction and returns the appropriate instance of the class from the ResolveExternalFunction(XmlTransaction, XmlManager, String, String, UInt64) method.

When the external method is called by XQuery, it will trigger the Execute(XmlManager, XmlArguments) method, passing in the XmlManager in which the operation is running, and the function arguments (contained in the XmlArguments instance). The function requires that an XmlResults argument be returned; however, a null value can be returned if appropriate.

Constructors

View Source

XmlExternalFunction()

Initializes a new instance of the XmlExternalFunction class.

Declaration
protected XmlExternalFunction()

Methods

View Source

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration
public void Dispose()
View Source

Execute(XmlManager, XmlArguments)

This method is called from within XQuery to execute the function for which the instance was implemented.

Declaration
public abstract XmlResults Execute(XmlManager mgr, XmlArguments args)
Parameters
Type Name Description
XmlManager mgr

The XmlManager controlling the operation.
XmlArguments args

XmlArguments object that can be used to retrieve the arguments passed to the operation.
Returns
Type Description
XmlResults

An XmlResults object used by the XQuery operation for further processing, or null.
View Source

Execute(XmlTransaction, XmlManager, XmlArguments)

This method is called from within XQuery to execute the function for which the instance was implemented.

Declaration
public abstract XmlResults Execute(XmlTransaction txn, XmlManager mgr, XmlArguments args)
Parameters
Type Name Description
XmlTransaction txn

The XmlTransaction in which the operation is running.
XmlManager mgr

The XmlManager controlling the operation.
XmlArguments args

XmlArguments object that can be used to retrieve the arguments passed to the operation.
Returns
Type Description
XmlResults

An XmlResults object used by the XQuery operation for further processing, or null.

Implements

System.IDisposable

See Also