hm_getcardimagename
Returns the name of the card image for the specified entity.
Syntax
hm_getcardimagename entity_type entity_name_or_id ?search_type?
Type
HyperMesh Tcl Query
Description
Returns the name of the card image for the specified entity. If a entity does not have a card image, an empty string is returned.
Inputs
- entity_type
- The type of entity to query.
- entity_name_or_id
- The name or ID of the entity to query.
- search_type
- By default, HyperMesh searches for entities by name, and if the name is not found, it then searches by ID. This option allows you to specify how the search for an entity should be conducted. Valid values are:
Example
To get the card image assigned to property named 100:
hm_getcardimagename props 100 -byid
Errors
Incorrect usage results in a Tcl error. To
detect errors, you can use the catch
command:
if { [ catch {command_name...} ] } {
# Handle error
}