XQuery.Compile Method (Uri, Stream, XQuerySettings)XQuery.Compile Method (Uri, Stream, XQuerySettings)XQuery::Compile Method (Uri^, Stream^, XQuerySettings^)

Loads and compiles the specified XQuery program and returns an XQuery XQuery XQuery object that represents the XQuery program. The specified static context settings are used.

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

Syntax

Public Shared Function Compile( _
    source As Uri, _
    stream As System.IO.Stream, _
    settings As XQuerySettings _
) As XQuery

public static XQuery Compile(
    Uri source,
    System.IO.Stream stream,
    XQuerySettings settings
)

public:
static XQuery^ Compile(
    Uri^ source, 
    System.IO::Stream^ stream, 
    XQuerySettings^ settings
)

Parameters

source

Type: System.UriSystem.UriSystem::Uri^

The base URI of the query.

stream

Type: System.IO.StreamSystem.IO.StreamSystem.IO::Stream^

The Stream Stream Stream from which to read the XQuery expression.

settings

Type: XmlPrime.XQuerySettingsXmlPrime.XQuerySettingsXmlPrime::XQuerySettings^

The initial static context settings.

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	stream or settings is `null` a null reference (`Nothing` in Visual Basic) `nullptr`.
XdmException XdmException XdmException	An error occurred compiling the query.

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.

If it is not null a null reference (Nothing in Visual Basic) nullptr, the source parameter is used as the base URI of the query if the query does not include a base-uri declaration.