hm_getmodelcheckcheckstatus

Returns the status for a given check.

Syntax

hm_getmodelcheckcheckstatus check_display_name

Type

HyperMesh Tcl Query

Description

Returns the status for a given check.
  • 0 - Check is not run
  • 1 - Check is run and there are failed entities
  • 2 - Check is run but there are no failed entities
  • 3 - Relevant entities to run the check are not present in the model

Inputs

check_display_name
The GUI display name of the check. This is case sensitive.

Examples

To get the status for the "Unused materials" check:

hm_getmodelcheckcheckstatus "Unused Materials"

Errors

Incorrect usage results in a Tcl error. To detect errors, you can use the catch command:
if { [ catch {command_name...} ] } {
   # Handle error
}

Version History

2019