XPath.CompilePattern MethodXPath.CompilePattern MethodXPath::CompilePattern Method

Compiles an XPath pattern and returns a XPath XPath XPath object that represents the expression.

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

Syntax

Public Shared Function CompilePattern( _
    pattern As String, _
    settings As XPathSettings _
) As XPath

public static XPath CompilePattern(
    string pattern,
    XPathSettings settings
)

public:
static XPath^ CompilePattern(
    String^ pattern, 
    XPathSettings^ settings
)

Parameters

pattern

Type: System.StringSystem.StringSystem::String^

An XPath pattern.

settings

Type: XmlPrime.XPathSettingsXmlPrime.XPathSettingsXmlPrime::XPathSettings^

The initial static context settings.

Return Value

Type: XmlPrime.XPathXmlPrime.XPathXmlPrime::XPath^

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

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.