Public Member Functions | List of all members
zorba::ExternalFunctionParameter Class Referenceabstract

Instances of subclasses of this abstract class may be used as parameters to the DynamicContext::addExternalFunctionParameter function. More...

#include <zorba/external_function_parameter.h>

Public Member Functions

virtual void destroy ()=0 throw ()
 This function is invoked by Zorba when the DynamicContext that contains the instance is destroyed. More...
 
virtual ~ExternalFunctionParameter ()
 Virtual destructor with an empty implementation. More...
 

Detailed Description

Instances of subclasses of this abstract class may be used as parameters to the DynamicContext::addExternalFunctionParameter function.

This is useful in the implementation of external modules/functions in order to store information between several invocations of the same function.

The destroy method is called by Zorba at the end of the execution of an XQuery program, when the corresponding DynamicContext is destroyed.

Definition at line 33 of file external_function_parameter.h.

Constructor & Destructor Documentation

virtual zorba::ExternalFunctionParameter::~ExternalFunctionParameter ( )
inlinevirtual

Virtual destructor with an empty implementation.

Definition at line 48 of file external_function_parameter.h.

Member Function Documentation

virtual void zorba::ExternalFunctionParameter::destroy ( ) throw ()
pure virtual

This function is invoked by Zorba when the DynamicContext that contains the instance is destroyed.

This allows the user to release resources. In the simplest case, an implementation might simply call "delete this" to destroy the object.


The documentation for this class was generated from the following file:
blog comments powered by Disqus