hm_getincludeid

Returns the include ID for the specified include name.

Syntax

hm_getincludeid name ?search_type?

Type

HyperMesh Tcl Query

Description

Returns the include ID for the specified include name.

Inputs

name
The name of the include file.
?search_type?
By default, HyperMesh searches for the include using the short name. This option allows you to specify how the search for the include should be conducted. Valid values are:
  • byshortname - The include is specified using the short name
  • byfullname - The include is specified using the full name.

Examples

To get the ID of the include with short name include.txt:

hm_getincludeid include.txt
or
hm_getincludeid include.txt -byshortname
To get the ID of the include with the full name C:/temp/my_include.txt:
hm_getincludeid C:/temp/my_include.txt -byfullname

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

10-SA1-120