Show Hide

 

Feedback

  • Contents
 

II3IDHandler2::IsExpressionValid Method

Synopsis

Returns whether or not the expression is valid for the specified type and whether or not the expression is an input or not.

IDL Function Prototype

HRESULT IsExpressionValid(

   [in] BSTR Expression,

   [in] VARIANT TypeSpecifier,

   [in] VARIANT_BOOL ExpressionIsInput,

   [in,out] BSTR * ErrorString,

   [out, retval] VARIANT_BOOL * IsValid

);

C/C++ Syntax

HRESULT IsExpressionValid(BSTR Expression, VARIANT TypeSpecifier, VARIANT_BOOL ExpressionIsInput, BSTR * ErrorString, VARIANT_BOOL * IsValid);

Parameters

Expression

The conditional expression whose formula is to be validated.

TypeSpecifier

TypeSpecifier denotes the type for the input parameter. It is a VARIANT that should be one of the three following types:

  • VT_BSTR: A string of the format "<TypeModule>::<TypeName>" that identifies the type for this parameter. For example, the string "::Integer" could be used to specify a type of Integer. In this case, the module name for the type is empty.

  • VT_UNKNOWN: he punkVal member should contain an IUnknown pointer to a COM object that implements the II3IDType interface.

  • VT_DISPATCH: The pdispVal member should contain an IDispatch pointer to a COM object that implements the II3IDType interface.

For VT_UNKNOWN and VT_DISPATCH, "the COM object that implements the II3IDType interface" means that it is a type object that was retrieved from a method off of an II3IDTypes call such as the II3IDTypes::Item method.

ExpressionIsInput

Specify True if this expression is an input, False for output expressions.

ErrorString

String that describes error condition.

IsValid

The return value is True if the expression is valid; otherwise False is returned.