::hwat::utils::CreateTitle

Creates a title for given entity in HyperMesh.

Syntax

::hwat::utils::CreateTitle str_titleName str_entityType n_entityID str_txtBuffer

Arguments

str_titleName
Name of the title to be created.
str_entityType
Type of entity to attach title to. Legal values include:
  • Undefined
  • Node
  • Element
  • Load
  • System
n_entityID
ID of the entity to which the title is to be attached. Can be "0" for "undefined".
str_txtBuffer
Title text that will be set to the newly created title.

Returns

Success
ID of the title created
Failure
{}

Example

::hwat::utils::CreateTitle MyTitle node 567 "This is some text"

Comments

Before creating the title, a check is made to see if the title exists. If it does, the function errors out and returns {}.