Symfindfirst - Texas Instruments TI-89 Developer's Manual

1034

SymFindFirst

Declaration: SYM_ENTRY * SymFindFirst (const BYTE * FolderName , WORD
Options )
Category(ies): Symbol Table Utilities (low level)
Description: Find the first symbol in the given folder and setup internal pointers so that
SymFindNext and SymFindPrev may be called to traverse the folder.
NOTE: Since this routine and subsequent calls to SymFindNext and SymFindPrev
Inputs: FolderName — Tokenized name of folder to traverse.
Options
Outputs: SYM_ENTRY pointer of first symbol found or NULL if none found.
None
Assumptions:
Heap compression will invalidate the pointers returned necessitating
Side Effects:
another call to SymFindFirst.
Availability: All versions of the TI-89 / TI-92 Plus.
TI-89 / TI-92 Plus Developer Guide
Appendix A: System Routines — Symbol Table Utilities
return direct pointers to the symbol table, anything that would cause heap
compression will cause the results to be invalid or may lock-up the system.
— The following flags may be set.
FO_RECURSE
The symbol table is searched recursively
(i.e., through the HOME symbol table and down
each folder), therefore, FolderName is ignored.
If and only if FO_RECURSE is set then
SymFindFoldername will return the name of
the folder for the symbol just returned.
FO_NOTEMPS
Used with FO_RECURSE to skip over any
temporary folders.
FO_CKTWINS
SymFindNext and SymFindPrev normally will
skip Flash entries corresponding to a twin entry.
Setting this will cause twin entries to be
returned.
FO_SKIP_COLLAPSE
Used with FO_RECURSE to skip variables in a
folder with the SF_COLLAPSE bit set.
(continued)
Not for Distribution Beta Version January 26, 2001