DeleteAll Method (TREEVIEW)


PLBCMP GUI Only

 

The DeleteAll method removes every item from a TREEVIEW object. The method uses the following format:

 

[label]

{object}.DeleteAll

[GIVING {return}]

 

Where:

label

Optional. A Program Execution Label.

object

Required. A TREEVIEW object from which all items are deleted.

return

Optional. A Numeric Variable that indicates the success or failure of the method.

Flags Affected: EOS, OVER, ZERO

Note the following:

  1. Upon completion, {return} will contain the status of the method as follows. $TRUE and $FALSE are defined in PLBEQU.INC.

  2.  

    Value

    Constant

    The deletion ...

    0

    $FALSE

    failed.

    1

    $TRUE

    was successful.

 

  1. If the value returned is zero, the ZERO Condition Flag is set.

  2. The OVER and EOS Condition Flags are always cleared.

  3. For improved performance in the Application Server environment, do not specify the optional return value unless needed.

 

 

See Also: Method Syntax, TREEVIEW Methods

 



PL/B Language Reference TREEVIEW Methods DeleteItem Method (TREEVIEW)