HSymDel Function (ROM Call 0x5F)

vat.h

short HSymDel (HSym Sym);

Deletes a symbol pointed to by HSym.

HSymDel acts exactly like SymDel, except it takes a structure of type HSym as an input parameter instead of the symbol name (see SYMSTR).

Note: This routine assumes that Sym is valid; if it is not, it may throw an error (for example, if Sym represents a reserved symbol like "main", or if the referenced symbol is in-use). If HSymDel is called to delete a folder than that folder must be empty! Also do not use HSymDel to delete twin or archived variables. This routine modifies the VAT table, so it invalidates any other existing HSyms. The caller must be sure that the VAT table has not been changed since Sym was obtained.


Uses: DerefSym, IsMainFolderStr, HeapFree, HeapRealloc, ER_catch, ER_success, ER_throwVar, next_expression_index, push_parse_text, top_estack, memmove, strcat, strchr, OSDisableBreak, OSEnableBreak, CheckGraphRef, statFree, _ds32s32
Used by: cmd_blddata, cmd_delfold, cmd_delvar, cmd_newdata, cmd_newprob, FDelete, gdb_recall, OSLinkCmd, de_initRes, de_loop, gr_ck_solvergraph, gr_remove_fldpic, spike_in_editor, spike_titles_in_editor, ROM Call 0x438, ROM Call 0x45E


See also: SymFind