IExpressionEval::EvalXML Method
Use this method to evaluate an expression represented as an Extensible Markup Language (XML) fragment.
HRESULT IExpressionEval::EvalXML(
BSTR bstrXMLExpr,
IDictionary* pDictObjs,
VARIANT* pvResult
);
Function EvalXML(
bstrXMLExpr As String,
DictObjs As Object
) As Variant
Parameters
bstrXMLExpr
[C++][in] A BSTR that contains the XML fragment to be evaluated.
[Visual Basic]
A String that contains the XML fragment to be evaluated.
pDictObjs
[C++][in] A pointer to the IDictionary interface of a Dictionary object that contains a set of profiles.
DictObjs
[Visual Basic]A Dictionary object that contains a set of profiles.
pvResult
[C++][out, retval] A pointer to a VARIANT indicating the results of evaluating the expression in the specified context.
Return Value
[C++]
This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details. The result of evaluating the expression is contained in the pvResult parameter. The result may be TRUE, FALSE, or NULL. NULL indicates the expression could not be evaluated.
[Visual Basic]
This method returns a Variant indicating the results of evaluating the expression in the specified context. This result may be True, False, or Nothing. Nothing indicates the expression could not be evaluated.
Error Values
[C++]
This method returns S_OK (0x00000000) to indicate success and either standard or custom COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors.
[Visual Basic]
This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to either standard or custom COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors.
The following table shows the custom COM errors that this method can return.
Constant |
Value |
Description |
|---|---|---|
E_EXPR_BADARGTYPE |
0x81100018 |
Argument data type information missing from expression, or unrecognized argument data type encountered in expression |
E_EXPR_BADARGVALUE |
0x81100022 |
Invalid expression argument value, or impossible conversion |
E_EXPR_BADCLAUSE |
0x81100016 |
Invalid clause encountered |
E_EXPR_BADCONNECTION |
0x8110001F |
Invalid connection |
E_EXPR_BADOPER |
0x81100017 |
Operator missing, unrecognized operator encountered, or type mismatch |
E_EXPR_BADTERM |
0x81100015 |
Term type missing, or unrecognized term type encountered |
E_EXPR_BADXML |
0x81100014 |
An unrecognized XML element was encountered |
E_EXPR_NOCONNECTIONSTRING |
0x8110000D |
No connection string specified |
E_EXPR_XMLPARSE |
0x81100013 |
XML DOM object parsing error |
Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.
Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.
Remarks
The XML is parsed before being evaluated.
Expressions evaluated with the EvalXML method are not persistent; that is, they are not stored in the expression store or loaded into the expression cache. Use the Eval method to evaluate persistent expressions.
A new ExprEvalContext object is created and then discarded for each XML fragment that is evaluated.
The Connect method must be called before using the EvalXML method.
The pvResult parameter contains valid data only if the method completes successfully.
Example
' sXMLExpr is a string.
' Note that this string is not formatted properly with respect to
' quotation marks or continuation in order to increase readability.
strXMLExpr = "<CLAUSE OPER="equal">
<PROPERTY ID="User.firstName" TYPE="string" />
<IMMED-VAL TYPE="string">Jill</IMMED-VAL>
</CLAUSE>"
' vResult is a Variant.
' dictProfiles is a Dictionary object containing a set of profiles.
vResult = oExpressionEval.EvalXML(sXMLExpr, dictProfiles)