<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>XdmFunctionItem</title>
<meta name="keywords" content="Saxon.Api.XdmFunctionItem class">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
</head>
<body>
<div style="width:20%; float:left; background-color:#c1cede; overflow:auto; height:100%">
<h2>Saxon.Api</h2>
<div style="position:relative; height:4pt">
<p>Class <a href="DocumentBuilder.html">DocumentBuilder</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="DomDestination.html">DomDestination</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="DynamicContext.html">DynamicContext</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="DynamicError.html">DynamicError</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="EmptyEnumerator.html">EmptyEnumerator</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="ExtensionFunctionCall.html">ExtensionFunctionCall</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="ExtensionFunctionDefinition.html">ExtensionFunctionDefinition</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="NullDestination.html">NullDestination</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="Processor.html">Processor</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="QName.html">QName</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="SchemaManager.html">SchemaManager</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="SchemaValidator.html">SchemaValidator</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="Serializer.html">Serializer</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="StaticContext.html">StaticContext</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="StaticError.html">StaticError</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="TextWriterDestination.html">TextWriterDestination</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="XPathCompiler.html">XPathCompiler</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="XPathExecutable.html">XPathExecutable</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="XPathSelector.html">XPathSelector</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="XQueryCompiler.html">XQueryCompiler</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="XQueryEvaluator.html">XQueryEvaluator</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="XQueryExecutable.html">XQueryExecutable</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="XdmAnyFunctionType.html">XdmAnyFunctionType</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="XdmAnyItemType.html">XdmAnyItemType</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="XdmAnyNodeType.html">XdmAnyNodeType</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="XdmAtomicType.html">XdmAtomicType</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="XdmAtomicValue.html">XdmAtomicValue</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="XdmDestination.html">XdmDestination</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="XdmEmptySequence.html">XdmEmptySequence</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="XdmFunctionItem.html">XdmFunctionItem</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="XdmItem.html">XdmItem</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="XdmItemType.html">XdmItemType</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="XdmNode.html">XdmNode</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="XdmNodeKind.html">XdmNodeKind</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="XdmSequenceType.html">XdmSequenceType</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="XdmValue.html">XdmValue</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="XmlDestination.html">XmlDestination</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="XsltCompiler.html">XsltCompiler</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="XsltExecutable.html">XsltExecutable</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Class <a href="XsltTransformer.html">XsltTransformer</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Enum <a href="RecoveryPolicy.html">RecoveryPolicy</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Enum <a href="SchemaValidationMode.html">SchemaValidationMode</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Enum <a href="TreeModel.html">TreeModel</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Enum <a href="WhitespacePolicy.html">WhitespacePolicy</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Enum <a href="XdmAxis.html">XdmAxis</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Interface <a href="IMessageListener.html">IMessageListener</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Interface <a href="IQueryResolver.html">IQueryResolver</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Interface <a href="IResultDocumentHandler.html">IResultDocumentHandler</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Interface <a href="IXdmEnumerator.html">IXdmEnumerator</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Interface <a href="IXmlLocation.html">IXmlLocation</a></p>
</div>
<div style="position:relative; height:4pt">
<p>Interface <a href="SchemaResolver.html">SchemaResolver</a></p>
</div>
</div>
<div style="width:5%; float:left; background-color:#e4eef0; overflow:auto; height:100%">
</div>
<div style="float:left; width:75%; overflow:auto; height:100%;">
<h2><font size="-1">Saxon.Api</font><br>Class XdmFunctionItem
</h2>
<hr>
<dl>
<dt><pre>public class XdmFunctionItem</pre></dt>
<dt> extends <a href="XdmItem.html">XdmItem</a></dt>
</dl>
<dl>
<dd>
<p>
The class <code>XdmFunctionItem</code> represents an item in an XPath 3.0 sequence
that represents a function.
</p>
<p>Note that there is no guarantee that every <code>XdmValue</code> comprising a single
function item will be an instance of this class. To force this, use the <code>Simplify</code>
property of the <code>XdmValue</code>.
</p>
<p>At present the only way of creating an instance of this class is as the result of
an XPath or XQuery expression that returns a function item. Note that this feature
requires
XPath 3.0 or XQuery 3.0 to be enabled, which in turn requires use of Saxon-EE.
</p>
</dd>
</dl>
<hr><a name="property_summary"></a><table border="1" width="100%" cellpadding="3" cellspacing="0" summary="">
<tr border="#ccccff" class="TableHeadingColor">
<th align="left" colspan="2"><font size="+2"><b>Property Summary</b></font></th>
</tr>
<tr bgcolor="white" class="TableRowColor">
<td align="right" valign="top" width="1%"><code> <a href="QName.html">QName</a></code></td>
<td><code><b><a href="#FunctionName">FunctionName</a></b></code><p>
The name of the function, as a QName. The result will be null if the function is anonymous.
</p>
</td>
</tr>
<tr bgcolor="white" class="TableRowColor">
<td align="right" valign="top" width="1%"><code> <a href="http://msdn.microsoft.com/en-us/library/system.int32(VS.80).aspx">int</a></code></td>
<td><code><b><a href="#Arity">Arity</a></b></code><p>
The arity of the function, that is, the number of arguments it expects
</p>
</td>
</tr>
</table> <a name="method_summary"></a><table border="1" width="100%" cellpadding="3" cellspacing="0" summary="">
<tr border="#ccccff" class="TableHeadingColor">
<th align="left" colspan="2"><font size="+2"><b>Method Summary</b></font></th>
</tr>
<tr bgcolor="white" class="TableRowColor">
<td align="right" valign="top" width="1%"><code> <a href="http://msdn.microsoft.com/en-us/library/system.boolean(VS.80).aspx">bool</a></code></td>
<td><code><b><a href="#IsAtomic()">IsAtomic</a></b>()</code><p>
Determine whether the item is an atomic value
</p>
</td>
</tr>
<tr bgcolor="white" class="TableRowColor">
<td align="right" valign="top" width="1%"><code> <a href="XdmValue.html">XdmValue</a></code></td>
<td><code><b><a href="#invoke(Saxon.Api.XdmValue[],Saxon.Api.Processor)">invoke</a></b>(Saxon.Api.XdmValue[] arguments, <a href="Processor.html">Processor</a> processor)</code><p>
Invoke the function
</p>
</td>
</tr>
</table> <a name="property_detail"></a><table border="1" width="100%" cellpadding="3" cellspacing="0" summary="">
<tr border="#ccccff" class="TableHeadingColor">
<th align="left" colspan="2"><font size="+2"><b>Property Detail</b></font></th>
</tr>
</table><a name="FunctionName"></a><h3>FunctionName</h3><pre>public <a href="QName.html">QName</a> <b>FunctionName</b> {get; }</pre><dl>
<dd>
<p>
The name of the function, as a QName. The result will be null if the function is anonymous.
</p>
</dd>
</dl>
<hr><a name="Arity"></a><h3>Arity</h3><pre>public <a href="http://msdn.microsoft.com/en-us/library/system.int32(VS.80).aspx">int</a> <b>Arity</b> {get; }</pre><dl>
<dd>
<p>
The arity of the function, that is, the number of arguments it expects
</p>
</dd>
</dl>
<hr><a name="method_detail"></a><table border="1" width="100%" cellpadding="3" cellspacing="0" summary="">
<tr border="#ccccff" class="TableHeadingColor">
<th align="left" colspan="2"><font size="+2"><b>Method Detail</b></font></th>
</tr>
</table><a name="IsAtomic()"></a><h3>IsAtomic</h3><pre>public override <a href="http://msdn.microsoft.com/en-us/library/system.boolean(VS.80).aspx">bool</a> <b>IsAtomic</b>()</pre><dl>
<dd>
<p>
Determine whether the item is an atomic value
</p>
<dl>
<dt>returns</dt>
<dd>
false (a function item is not an atomic value)
</dd>
</dl>
</dd>
</dl>
<hr><a name="invoke(Saxon.Api.XdmValue[],Saxon.Api.Processor)"></a><h3>invoke</h3><pre>public <a href="XdmValue.html">XdmValue</a> <b>invoke</b>(Saxon.Api.XdmValue[] arguments,
<a href="Processor.html">Processor</a> processor)</pre><dl>
<dd>
<p>
Invoke the function
</p><b>Parameters:</b><dl>
<dt><code>arguments</code> -
</dt>
<dd>The arguments to the function</dd>
</dl>
<dl>
<dt><code>processor</code> -
</dt>
<dd>The Saxon processor, used to provide context information</dd>
</dl>
<dl>
<dt>returns</dt>
<dd>The result of calling the function</dd>
</dl>
</dd>
</dl>
<hr>
</div>
</body>
</html>
