# $window.list

Generates lists of windows

Syntax

    $window.list(<type>[,<irc_context_id>])

Description

Returns an array of window identifiers with a speficied type and eventually belonging to a specified irc context.
<type> is a window type such as 'query' or 'channel'.
See window.listtypes for a list of available window types in this KVIrc release.
If <type> is the special word 'all', all the window types are listed.
<irc_context_id> specifies the irc context in which the windows are searched.
If no <irc_context_id> is specified , the current one is used.
If <irc_context_id> is the special word 'all' , all the irc context are searched.
The windows that do not belong to any irc context (such as DCC windows), must be searched by using 'all' as <irc_context_id>.

Examples

        # List all the queries of the current irc context
        echo $window.list(query)
        # Equivalent to the above
        echo $window.list(query,$ic)
        # List all the channels in all the irc contexts
        echo $window.list(channel,all)
        # List all the windows in the current irc context
        echo $window.list(all)
        # List all the windows in all irc contexts
        echo $window.list(all,all)
        # List all the DCC Send windows
        echo $window.list(dccsend,all)

See also
window.listtypes

Main index, Function index

KVirc 3.0.0 documentation
Generated by root at Thu Apr 29 12:41:05 2004