XQuery.Compile Method (string)XQuery.Compile Method (String)XQuery::Compile Method (String^)

Compiles the specified XQuery program and returns an XQuery XQuery XQuery object that represents the XQuery program. Default static context settings are used.

Namespace: XmlPrime XmlPrime XmlPrime
Assembly: XmlPrime (in XmlPrime.dll)

Syntax

Public Shared Function Compile( _
    query As String _
) As XQuery

public static XQuery Compile(
    string query
)

public:
static XQuery^ Compile(
    String^ query
)

Parameters

query

Type: System.StringSystem.StringSystem::String^

An XQuery program.

Return Value

Type: XmlPrime.XQueryXmlPrime.XQueryXmlPrime::XQuery^

An XQuery XQuery XQuery object, or null a null reference (Nothing in Visual Basic) nullptr if an unrecoverable error was raised and handled by a subscriber to CompilationError CompilationError CompilationError

Exceptions

Exception	Condition
ArgumentNullException ArgumentNullException ArgumentNullException	query is `null` a null reference (`Nothing` in Visual Basic) `nullptr`.
XdmException XdmException XdmException	An error occurred compiling the query.
LicenceException LicenceException LicenceException	This version of XmlPrime has expired.

Remarks

Any errors or warnings encountered during compilation raise the CompilationError CompilationError CompilationError event. If nothing subscribes to this event then an XdmException XdmException XdmException is thrown if an unrecoverable error is encountered. If this event is subscribed to then the exception is not thrown, and this method returns null a null reference (Nothing in Visual Basic) nullptr instead.