Arbortext Command Language > Functions by Alphabetical Listing > window_list
  
window_list
window_list (arr[, class[, window[, flags]]])
This function fills the array arr with a list of all existing windows of class class, or all windows if class is not specified. It returns the number of window identifiers stored in the array. The window identifiers are returned in no particular order.
If window is specified, only the subwindows belonging to the frame containing window are returned. If the flags parameter is given, window may be given as -1 to mean unspecified.
The optional flags parameter is a bitmask that limits the window ids returned. The value is constructed using OR with the following flags:
0x01 — Return only the active window in a given frame. For example, if the frame has a window split or command window, return only the window which last had keyboard focus.
0x02 — Return only top level windows. That is, return only those windows that do not have a parent window.
Example:
window_list(arr, "edit", win)
The function call above would return all the edit panes associated with the window specified by win.
Related Topics
window_id function
window_class function
window_count function