User Tools

Site Tools


mychannels

# $EPIC: mychannels.txt,v 1.3 2006/08/01 05:18:26 sthalik Exp $

Synopsis:

$mychannels()
$mychannels(<server refnum>)
$mychannels(#<window refnum>)
$mychannels(<window name>)

Technical:

  • This function returns a space separated word list of all of the currently active channels on the specified server. Pending channels (those which you have sent off a JOIN but have not received a reply back from the server) are NOT included.
  • If the argument is a number, then it is taken as a server refnum, and the channels of that server are returned.
  • If the argument starts with the literal hash character ('#'), then it is taken as a window refnum and the channels of the server that window is connected to are returned.
  • Otherwise the argument is taken as a window name and the channels of the server that window is connected to are returned.
  • If the argument is invalid (the server refnum is less than zero or too high; the window refnum is not in use; the window name is not in use; the window is in use but is disconnected), the empty string is returned.

Practical:

When you need to know all of the channels you are connected to on a server, perhaps because you want to send a message to all of them.

History:

This function first appeared in ircII-2.2.2.

mychannels.txt · Last modified: 2006/08/01 20:54 (external edit)