Appendix A: System Routines — Variables
1137
TI
-
89 / TI
-
92 Plus Developer Guide
Not for Distribution
Beta Version January 26, 2001
cmd_rename
Declaration:
void
cmd_rename
(EStackIndex
OldSym
, EStackIndex N
ewSym
)
Category(ies):
Variables
Description:
Rename a variable. This is the TI
-
BASIC command Rename. As specified
in the Managing Variables section of the Memory Management chapter,
these routines should be used instead of the low-level symbol table
routines.
Inputs:
OldSym
— EStackIndex of source variable.
NewSym
— EStackIndex of destination variable.
Outputs:
May throw these errors (plus any that
VarRecall
might throw):
ER_RESERVED — Illegal rename of a reserved name.
ER_LOCKED — Cannot rename to or from locked or in-use
variables.
ER_DUPLICATE_VAR_NAME —
OldSym
and
NewSym
refer to same
variable.
ER_DATATYPE — Conflict between source and destination
data type.
ER_UNDEFINED_VAR —
OldSym
not found.
ER_MEMORY — Not enough memory to do rename.
ER_FOLDER — System variables can only reside in MAIN.
Assumptions:
None
Side Effects:
May cause heap compression.
Availability:
On AMS 1.05 and higher.
TI
-
89 / TI
-
92 Plus
Differences:
None
See Also: VarRecall, VarStore, TokenizeSymName
(continued)