Syntax

LabVIEWParameter.IsParameterMappingValid( reasonNotValid)

Return Value

Boolean

Returns True when all the following conditions are true:

1. the parameter is a cluster or cluster array or enumeration or enumeration array,
2. the argument expression is valid and not empty,
3. the cluster mapping of the argument is valid if the parameter is a cluster, and
4. the argument value is compatible with the enumeration parameter if the parameter is an enumeration.

In all other cases, returns False .

Purpose

Returns a value that indicates whether the argument you specify for a LabVIEW cluster or cluster array parameter is valid.

Remarks

This method checks the cluster passing information for any custom data types used and confirms that the information matches the cluster definition stored when you specified the module. For an enumeration parameter, the method validates that:

1. If the argument is a number or TestStand enumeration type instance, the numeric representation is compatible with the LabVIEW parameter�s representation.
2. If the argument is a TestStand enumeration type, the enumerators of the TestStand type must match the enumerators of the LabVIEW parameter in
   • Number and
   • Name and value .

Parameters

reasonNotValid As String

[Out] When this method returns False , this parameter returns an explanation for why the argument is invalid.