Window Identifiers

 

$active

Returns the full name of the currently active window.

 

Note: This identifier also has a multi-server counterpart.

 

$activewid

Returns window id for the currently active window.

 

$appactive

Returns $true if mIRC is the active application, otherwise it returns $false.

 

$appstate

Returns the display state of the mIRC window: minimized, maximized, normal, hidden, or tray.

 

$chan(N/#)

Returns information on channels that you are currently on.

 

Properties: topic, mode, key, limit, ial, logfile, stamp, status, inwho, wid, cid, hwnd, ibl, iel, iil

 

If you specify a number N, the Nth channel name is returned.

 

$chan(0)        returns the number of channels you are on

$chan(2)        returns the name of the 2nd channel you are on

$chan(2).key  returns the key of the 2nd channel you are on

 

$chan(4).ial returns $true if Internal Address List contains addresses of all users on this channel, $false if it doesn't.

 

$chan(4).inwho returns $true if you sent a /who #channel to the server to fill the IAL with addresses from that channel, and the /who is still in progress.

 

$chan(1).ibl/iel/iil return $true if mIRC has already seen a /mode +b/e/I and has a ban/exception/invite list for the channel, $false otherwise. If in the process of retrieving a list, return $inmode. See the $ibl() identifier for more information.

 

If you specify a channel name, information on that channel is returned but only if you are on that channel.

 

$chan(#mIRC).mode  returns the mode of channel #mIRC

 

The status property returns the value joining, joined, or kicked.

 

$chat(N/nick[,N])

Returns the name of the Nth open dcc chat window.

 

Properties: ip, status, logfile, stamp, wid, cid, hwnd

 

$chat(0)     returns the total number of open dcc chats

$chat(1)     returns the nickname of the 1st dcc chat window

$chat(2).ip  returns the ip address of the 2nd open dcc chat window

 

If you specify a nick and N, it will return info on the Nth window for that nick.

 

$fserv(N/nick,[N])

Returns the name of the Nth open fileserver window.

 

Properties: ip, status, cd

 

$fserv(0)       returns the total number of open fserves

$fserv(1)       returns the nickname of the 1st fserve

$fserv(1).cd  returns the current directory of the 1st fserve

 

If you specify a nick and N, it will return info on the Nth window for that nick.

 

$get(N/nick,[N])

Returns the nickname and filename of the Nth open dcc get window.

 

Properties: ip, status, file, path, size, rcvd, cps, pc, secs, done, resume, wid, cid, hwnd

 

$get(0)         returns the total number of open dcc gets

$get(2)         returns the nickname of the 2nd dcc get

$get(2).rcvd  returns the number of bytes received for the 2nd dcc get

$get(2).cps   returns the character per second rate for the 2nd dcc get

$get(3).pc     returns the percent complete of transfer for the 3rd dcc get

$get(1).secs  returns the number seconds connection has been open

$get(1).done  returns $true if transfer was successful, $false otherwise

$get(1).resume        returns resume position if file was resumed

 

If you specify a nick and N, it will return info on the Nth window for that nick.

 

$get(1).status returns "sent" and "failed" if a transfer has been sent successfully or failed.

 

$lactive

Returns full window name of the last active window.

 

$lactivewid

Returns window id for the last active window.

 

$query(N/nick)

Returns the nickname of the Nth open query window.

 

Properties: addr, logfile, stamp, wid, cid, hwnd

 

$query(0)  returns the total number of open query windows

$query(2)  returns the name of the 2nd open query window

 

$query(N).addr  returns the address of the Nth query, however note that this address is not available until after the user has sent you a message, and that this address might not be correct.

 

$send(N/nick[,N])

Returns the nickname and filename of the Nth open dcc send window.

 

Properties: ip, status, file, path, size, sent, lra, cps, pc, secs, done, resume, wid, cid, hwnd

 

$send(0)            returns the total number of open dcc sends

$send(2)            returns the nickname of the 2nd dcc send

$send(2).sent     returns the number of bytes sent for the 2nd dcc send

$send(2).lra       returns the last received ack for the 2nd dcc send

$send(3).pc       returns the percent complete of transfer for the 3rd dcc send

$send(3).status  returns active, inactive, or waiting for the 3rd dcc send

$send(1).secs    returns the number seconds connection has been open

$send(1).done    returns $true if transfer was successful, $false otherwise

$send(1).resume        returns resume position if file was resumed

 

If you specify a nick and N, it will return info on the Nth window for that nick.

 

$wid

Returns window id for current script.