LabVIEWParameterElement.IsClusterMappingInvalid

Syntax

LabVIEWParameterElement.IsClusterMappingInvalid( reasonNotValid)

Return Value

Boolean

Returns True when all the following conditions are true:

  • The parameter is a cluster or cluster array
  • The argument expression is valid and non-empty
  • The argument or cluster mapping of the argument is invalid

In all other cases, this method returns False .

Purpose

Returns a value that indicates whether the argument you specify for a LabVIEW cluster or cluster array parameter is valid by checking the cluster passing information for any custom data types used to confirm that the information matches the cluster definition stored when you specified the module.

Note This method does not load the VI you specify. The method relies on the cluster information stored for the parameter when the module was last specified.

Parameters

reasonNotValid As String

[Out] When this method returns True , this parameter returns the reason why the argument is invalid.