DeleteItem Method (TREEVIEW)
PLBCMP GUI Only
The DeleteItem method removes one item from a TREEVIEW object. The method uses the following format:
|
|
|
|
Where:
label
Optional. A Program Execution Label.
object
Required. A TREEVIEW object from which an item is deleted.
return
Optional. A Numeric Variable that indicates the success or failure of the method.
item
Required. A decimal number or Numeric Variable that indicates the handle of the item to delete.
Flags Affected: EOS, OVER, ZERO
Note the following:
{item} is an item handle indicating the item that is deleted.
If {item} is the constant TVI_ROOT as defined in PLBMETH.INC or a value of zero, all items within the object are deleted.
Upon completion, {return} will contain the status of the method as follows. $TRUE and $FALSE are defined in PLBEQU.INC.
|
Value |
Constant |
The deletion ... |
|
0 |
$FALSE |
failed. |
|
1 |
$TRUE |
was successful. |
If the value returned is zero, the ZERO Condition Flag is set.
The OVER and EOS Condition Flags are always cleared.
For improved performance in the Application Server environment, do not specify the optional return value unless needed.
See Also: Method Syntax, TREEVIEW Methods
|
|