HyperWorks Tools

::hwat::utils::RenameEntity

::hwat::utils::RenameEntity

 Previous topic Next topic No expanding text in this topic  

::hwat::utils::RenameEntity

 Previous topic Next topic JavaScript is required for expanding text JavaScript is required for the print function  

NAME

::hwat::utils::RenameEntity - Renames entity collectors of given ID and type.

 

SYNTAX

::hwat::utils::RenameEntity n_entityID str_entityNewName  str_entityType

 

ARGUMENTS

n_entityID

HM ID of the entity being renamed.

str_entityNewName

New name to be assigned to the entity.

str_entityType

Type of collector("comps", "assems").

 

RETURNS

New name on success, {} on failure.

 

EXAMPLE

::hwat::utils::RenameEntity  903 myStuff comps

 

Comment

If the new name is already taken, the code will return the failure and take no action.

 

See also

Utils Functions