Cmd_Rename - Texas Instruments TI-89 Developer's Manual

Appendix A: System Routines — Variables

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
NewSym — EStackIndex of destination variable.
Outputs: May throw these errors (plus any that VarRecall might throw):
ER_RESERVED
ER_LOCKED
ER_DUPLICATE_VAR_NAME — OldSym and NewSym refer to same
ER_DATATYPE
ER_UNDEFINED_VAR
ER_MEMORY
ER_FOLDER
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
TI-89 / TI-92 Plus Developer Guide
— EStackIndex of source variable.
— Illegal rename of a reserved name.
— Cannot rename to or from locked or in-use
— Conflict between source and destination
— OldSym not found.
— Not enough memory to do rename.
— System variables can only reside in MAIN.
(continued)
Not for Distribution
variables.
variable.
data type.
Beta Version January 26, 2001
1137