3.1. Guidelines for Parameter Names

Parameter names must:

  • Begin with a letter

  • Contain only letters, numbers, and underscore characters

  • Contain no more than 32 characters

Examples of valid and invalid parameter names are

Valid:
ABC
PI
X_OR_Y
Invalid:
MY_PARAMETER_NAME_LONGER_THAN_32_CHARACTERS (more than 32 characters)
2CF3 (begins with a number)
M&E (invalid character "&")

When naming parameters:

  • Avoid parameter names that match commonly used Mechanical APDL labels, such as:

    • Degree of freedom (DOF) labels (TEMP, UX, PRES, etc.)

    • Convenience labels (ALL, PICK, STAT, etc.)

    • User-defined labels (such as those defined with the ETABLE command)

    • Array type field labels (such as CHAR, ARRAY, TABLE, etc.)

  • Parameter names ARG1 through ARG9 and AR10 through AR99 are reserved for local parameters. Generally, local parameters are used in macros (see Local Variables). Use of these names as "regular" parameters is not recommended.

  • Parameter names must not match abbreviations defined with the *ABBR command. For more information about abbreviations, see Adding Commands to the Toolbar.

  • Do not begin parameter names with an underscore (_). This convention is reserved for parameters used by the GUI and Mechanical APDL-provided macros.

  • APDL programmers supporting an organization should consider naming their parameters with a trailing underscore(_). These can be displayed as a group using the *STATUS command and deleted from memory as a group through the *DEL command.

  • Older Mechanical APDL-provided macro files may use parameter names that do not begin with an underscore. Using these macros embedded in your own macros may cause conflicts if the same parameter names are used.

 

3.1.1. Hiding Parameters from *STATUS

Listing Parameters discusses listing parameters through the *STATUS command. You can use a parameter naming convention to "hide" parameters from the *STATUS command. Any parameter whose name ends in an underscore (_) is not listed by *STATUS.

This capability was added specifically for those who are developing APDL macros for large audiences. You can use this to build macros that your Mechanical APDL users and other macro programmers cannot list.