FunctionKey Class Reference

#include <FunctionKey.hpp>

Inherits Function.

Collaboration diagram for FunctionKey:

List of all members.

Public Types

• typedef Function ParentType

Public Member Functions

• FunctionKey ()
• virtual ~FunctionKey ()
• virtual XObjectPtr execute (XPathExecutionContext &executionContext, XalanNode *context, const XObjectPtr arg1, const XObjectPtr arg2, const Locator *locator) const

  Execute an XPath function object.
  

• virtual FunctionKey * clone (MemoryManager &theManager) const

  Create a copy of the function object.
  

Protected Member Functions

• virtual const XalanDOMString & getError (XalanDOMString &theResult) const

  Get the error message to report when the function is called with the wrong number of arguments.
  

---

Detailed Description

Definition at line 43 of file FunctionKey.hpp.

---

Member Typedef Documentation

typedef Function FunctionKey::ParentType

Definition at line 47 of file FunctionKey.hpp.

---

Constructor & Destructor Documentation

FunctionKey::FunctionKey

(

)

virtual FunctionKey::~FunctionKey

(

)

[virtual]

---

Member Function Documentation

virtual FunctionKey* FunctionKey::clone

(

MemoryManager &

theManager

)

const [virtual]

Create a copy of the function object.

Returns:

pointer to the new object

Implements Function.

virtual XObjectPtr FunctionKey::execute	(	XPathExecutionContext &	executionContext,
		XalanNode *	context,
		const XObjectPtr	arg1,
		const XObjectPtr	arg2,
		const Locator *	locator
	)			const [virtual]

Execute an XPath function object.

The function must return a valid object. Called if function has two parameters.

Parameters:

	executionContext	executing context
	context	current context node
	arg1	pointer to XObject argument
	arg2	pointer to XObject argument
	locator	Locator instance for the XPath expression that contains the function call

Returns:

pointer to the result XObject

Reimplemented from Function.

virtual const XalanDOMString& FunctionKey::getError

(

XalanDOMString &

theBuffer

)

const [protected, virtual]

Get the error message to report when the function is called with the wrong number of arguments.

Parameters:

theBuffer

The XalanDOMString for the message.

Returns:

The error message

Implements Function.

---

The documentation for this class was generated from the following file:

• FunctionKey.hpp