<-- Previous || Up || Next -->

Remove Function
Symbol Table Class

Public Function Remove( _
      ByVal vName As Variant _
    , Optional ByVal vCompare As Variant _
    ) As Boolean

Remove a defintion (Name and Value pair) from the Symbol Table.
Function returns True if the Name was found and its Value was removed.
Function returns False otherwise.

Example: 
    Assuming
       Dim stTemp As New SymbolTable
       stTemp.Add "FunctionName", 23
       stTemp.Add "FunctionName", 24
    for example
       stTemp.Remove("FunctionName") = True
    leaves
       stTemp.Count = 1
See also: 
    RemoveAll Subroutine
    Lookup Function
    Add Subroutine
vName: The string or numeric identifier of the Symbol Table entry that is to be removed.
vCompare: Specifies the type of string comparison used to determine if Names match. vCompare defaults to the value of the Compare Property if it is missing.
v2.0 Change: Changed the vCompare argument so that it can no longer be Null or non-numeric. It is still Optional though, so it can be missing.
Note: If there are multiple Symbol Table definitions with the same Name, this function will remove the one that was mostly-recently-added.
Performance: This function can be inefficient because it scans the Symbol Table from end to beginning looking for the spefied Name.

Copyright 1996-1999 Entisoft
Entisoft Tools is a trademark of Entisoft.