hm_getincludes

Returns a list of include IDs or names.

Syntax

hm_getincludes ?-byshortname?|?-byfullname?|?-byshortnameexportpair?|?-byshortnamesolverflagpair?

Type

HyperMesh Tcl Query

Description

Returns a list of include IDs or names. Only one argument may be specified at a time. If no argument is specified, the IDs are returned.

The IDs and names are returned in the same order.

Inputs

byshortname
Returns the list of includes by their short names.
byfullname
Returns the list of includes by their full path names.
byshortnameexportpair
Returns the list of includes by their short names, along with the export flag for each.
byshortnamesolverflagpair
Returns the list of includes by their short names, along with the solver flag for each.
byshortnamealwaysmergeflagpair
Returns the list of includes by their short names, along with the always merge flag for each.

Example

To get the list of include IDs:

hm_getincludes

To get the list of include short names:

hm_getincludes -byshortname

Errors

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