ActiveXParameter.IsParameterMappingInvalid

Syntax

ActiveXParameter.IsParameterMappingInvalid( reasonNotValid)

Return Value

Boolean

Returns true if the parameter in the code module is an enum, the argument expression is valid and non-empty, and the mapping of the argument to the parameter in the code module is invalid. Returns false otherwise.

Purpose

Indicates if the TestStand enumeration data type of the argument conflicts with the definition of the corresponding enum parameter in the code module.

Remarks

The primary purpose of this method is to support error reporting. Therefore, cases where the mapping is not well defined, for example when the argument expression is empty, are not considered invalid. If an empty expression is considered an error condition, the application must check for it separately.

This method does not load the specified assembly. The method relies on the type information stored for the parameter when the module was last specified.

Parameters

reasonNotValid As String

[Out] If the mapping is invalid, reasonNotValid contains an error message explaining why the type definitions do not match. If the mapping is valid, reasonNotValid is set to an empty string.