SortChildren Method (TREEVIEW)
PLBCMP GUI Only
The SortChildren method orders the child items of the given parent item in a TREEVIEW object. The method uses the following format:
|
|
|
|
|
|
|
|
Where:
label
Optional. A Program Execution Label.
object
Required. A TREEVIEW object modified.
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 parent item whose children are sorted.
recurse
Required. A decimal number or Numeric Variable that indicates that all subordinate levels of children are sorted.
Flags Affected: EOS, OVER, ZERO
Note the following:
{item} is an item handle indicating the parent item to sort.
If {recurse} is $TRUE, all levels of child items descending from the given parent item are sorted. Otherwise, only immediate child items are sorted.
Upon completion, {return} will contain the status of the method as follows. $TRUE and $FALSE are defined in PLBEQU.INC.
|
Value |
Constant |
The sort ... |
|
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
|
|