Texas Instruments TI-89 - Tokenizesymname

1124
Appendix A: System Routines — Variable Name Utilities
TI
-
89 / TI
-
92 Plus Developer Guide
Not for Distribution
Beta Version January 26, 2001
TokenizeSymName
Declaration:
EStackIndex
TokenizeSymName
(BYTE *
StrSymName
, BOOL
Flags
)
Category(ies):
Variable Name Utilities
Description:
Convert a symbol name in standard C string format to a tokenized name
and push it on the ESTACK, returning a pointer to the old
top_estack
. The
caller must restore the ESTACK. Returns NULL if the symbol name was
invalid.
Inputs:
StrSymName
— Input symbol name in standard C format (points to first
character of the string).
Flags
— TSF_ALLOW_RESERVED
Allow reserved names to be tokenized (otherwise
they cause an error).
TSF_FULLY_QUALIFIED
Add current default folder to name if no folder
specified in name (do not use if tokenizing stand
alone folder names — to use for
cmd_newfold
and
cmd_delfold
for example).
TSF_PASS_ERRORS
Use ER_THROW on any errors instead of
returning NULL.
Outputs:
Original ESTACK pointer, NULL if error in name.
If Flags, TSF_PASS_ERRORS is set then may throw
INVALID_PATHNAME_ERROR or ER_RESERVED errors.
Assumptions:
This is the only routine that can be used to tokenize folder names.
TokenizeName
(in the FILE system) can only be used to tokenize variable
names.
Side Effects:
May cause heap compression.
Availability:
All versions of the TI
-
89 / TI
-
92 Plus.
TI
-
89 / TI
-
92 Plus
Differences:
None
See Also: TokenizeName
Example:
See
FolderCur
or
cmd_delvar
for an example.
FolderCur
contains code
for a utility
TokenizeFoldName
, a routine like
TokenizeName
only it can
handle folder names.