XQuery.Compile Method (IXPathNavigable, XQuerySettings)XQuery.Compile Method (IXPathNavigable, XQuerySettings)XQuery::Compile Method (IXPathNavigable^, XQuerySettings^)
Compiles the XQuery program expressed using the XML Syntax for XQuery 1.0 (XQueryX)
and returns an XQueryXQueryXQuery object that represents the XQuery program.
The specified static context settings are used.
Syntax
Public Shared Function Compile( _ query As System.Xml.XPath.IXPathNavigable, _ settings As XQuerySettings _ ) As XQuery
public static XQuery Compile( System.Xml.XPath.IXPathNavigable query, XQuerySettings settings )
public: static XQuery^ Compile( System.Xml.XPath::IXPathNavigable^ query, XQuerySettings^ settings )
Parameters
- query
Type: System.Xml.XPath.IXPathNavigableSystem.Xml.XPath.IXPathNavigableSystem.Xml.XPath::IXPathNavigable^
An XQuery program expressed using the XML Syntax for XQuery 1.0 (XQueryX).
- settings
Type: XmlPrime.XQuerySettingsXmlPrime.XQuerySettingsXmlPrime::XQuerySettings^
The initial static context settings.
Return Value
Type: XmlPrime.XQueryXmlPrime.XQueryXmlPrime::XQuery^
An XQueryXQueryXQuery object, or null
a null reference (Nothing
in Visual Basic)
nullptr
if an unrecoverable error was raised and handled
by a subscriber to CompilationErrorCompilationErrorCompilationError
Exceptions
Exception | Condition |
ArgumentNullExceptionArgumentNullExceptionArgumentNullException |
query or settings is null
a null reference (Nothing in Visual Basic)
nullptr .
|
XdmExceptionXdmExceptionXdmException | An error occurred compiling the query. |
Remarks
Any errors or warnings encountered during compilation raise the CompilationErrorCompilationErrorCompilationError event. If nothing subscribes to this event then an XdmExceptionXdmExceptionXdmException is thrown if an unrecoverable error is encountered. If this event is subscribed to then the exception is not thrown, and this method returnsnull
a null reference (Nothing
in Visual Basic)
nullptr
instead.