Name
Listtree.FindName -- find node by name
Synopsis
found, table = mui.DoMethod(id, "FindName", listnode$, name$, flags$)
Function
Find a node whose name matches the specified one. The search is done without paying attention to case sensitivity.

Listnode$ specifies the node whose list is used to find the name. This can be the string identifier of a node or one of the following special values:

Root
The root list.

Active
The list of the active node.

Flags$ can be a combination of the following options:

SameLevel
Only nodes on the same level are affected.

Visible
Only visible entries are taken into account.

If you specify multiple of the flags above, you have to separate them using a semicolon, e.g. "SameLevel; Visible".

This method returns two values: The first return value is a boolean flag which indicates whether or not a node was found. If the first return value is True, the second return value is a table with the following fields initialized:

Name
Name of the tree node. As the search is conducted in case insensitive mode, this item allows you to find out the real spelling of the entry.

Node
True if the found entry is a node, False if it is a leaf.

ID
String object identifier of this tree node.

MuiID
Internal MUI ID of this tree node. This can be used with Listtree.GetEntry.

Inputs
id
id of the listtree object
listnode$
id of list node to use or special value (see above)
name$
name to look for
flags$
lookup flags (see above)
Results
found
boolean flag indicating whether or not an entry was found
table
table containing information about found entry

Show TOC