From WikiChip
Difference between revisions of "mirc/identifiers/$abook"
< mirc‎ | identifiers

(Properties)
 
(One intermediate revision by the same user not shown)
Line 3: Line 3:
  
 
== Synopsis ==
 
== Synopsis ==
<pre>$abook(nick,N)[.property]</pre>
+
<pre>$abook(nick/N[,N])[.property]</pre>
  
 
== Parameters ==
 
== Parameters ==
<span style="display: inline-block; width: 50px;">'''nick'''</span>The nickname that you wish to look up in the address book. This can be a {{mirc|wildcard}} such as ''ni*'', which would find all nicknames beginning with ''ni''.
+
* '''nick/N''' - The nickname that you wish to look up in the address book. This can be a {{mirc|wildcard}} such as ''ni*'', which would find all nicknames beginning with ''ni''. It can also be the Nth nickname in the book.
 
+
* '''N''' - This will return the Nth matching nickname relative to the '''nick''' parameter. If N is 0, it will return the total matches.
<span style="display: inline-block; width: 50px;">'''N'''</span>This will return the Nth matching nickname relative to the '''nick''' parameter. If N is 0, it will return the total matches.
 
  
 
== Properties ==
 
== Properties ==
{| class="wikitable" style="margin-left: 75px;"
+
* '''nick''' - Returns the nickname attached to the specific address book match.
|-
+
* '''info''' - Returns the info area of the address book for the match, specifically the address.
! Property !! Description
+
* '''email''' - Returns the email associated with the address book match.
|-
+
* '''website''' - Returns the website URL associated with the address book match.
| '''nick''' || Returns the nickname attached to the specific address book match.
+
* '''picture''' - Returns the filename of the picture, if any, associated with the address book match.
|-
+
* '''ipaddr''' - Returns the ip address, if any, associated with the address book match.
| '''info''' || Returns the info area of the address book for the match, specifically the address.
+
* '''noteN''' - Returns the information in the notes area for the address book match where N is the Nth line
|-
 
| '''email''' || Returns the email associated with the address book match.
 
|-
 
| '''website''' || Returns the website URL associated with the address book match.
 
|-
 
| '''picture''' || Returns the filename of the picture, if any, associated with the address book match.
 
|-
 
| '''ipaddr''' || Returns the ip address, if any, associated with the address book match.
 
|-
 
| '''noteN''' || Returns the information in the notes area for the address book match where N is the Nth line
 
|}
 
  
 
== Example ==
 
== Example ==

Latest revision as of 15:17, 4 May 2023

$abook will return information about nicknames listed inside of the mIRC Address Book.


Synopsis[edit]

$abook(nick/N[,N])[.property]

Parameters[edit]

  • nick/N - The nickname that you wish to look up in the address book. This can be a wildcard such as ni*, which would find all nicknames beginning with ni. It can also be the Nth nickname in the book.
  • N - This will return the Nth matching nickname relative to the nick parameter. If N is 0, it will return the total matches.

Properties[edit]

  • nick - Returns the nickname attached to the specific address book match.
  • info - Returns the info area of the address book for the match, specifically the address.
  • email - Returns the email associated with the address book match.
  • website - Returns the website URL associated with the address book match.
  • picture - Returns the filename of the picture, if any, associated with the address book match.
  • ipaddr - Returns the ip address, if any, associated with the address book match.
  • noteN - Returns the information in the notes area for the address book match where N is the Nth line

Example[edit]

Echo all address matches to the active window

//echo -a $abook(*,0)

Echo the filename for the picture of the first address book match to the active window

//echo -a $abook(*,1).picture

Compatibility[edit]

Added: mIRC v5.6
Added on: 03 Jun 1999
Note: Unless otherwise stated, this was the date of original functionality.
Further enhancements may have been made in later versions.


See Also[edit]

/abook

v · d · e mIRC identifier list

$ $$, $, $0, $1-, $!, $&, $*, $+, $++, $?

A $abook, $abs, $acos, $active, $activecid, $activewid, $adate, $address, $addtok, $addtokcs, $agent, $agentname, $agentstat, $agentver, $alias, $and, $anick, $ansi2mirc, $aop, $appactive, $appstate, $asc, $asctime, $asin, $atan, $atan2, $auto, $avoice, $away, $awaymsg, $awaytime

B $banlist, $banmask, $base, $beta, $bfind, $bindip, $bitoff, $biton, $bits, $bnick, $bvar, $bytes

C $calc, $caller, $cancel, $cb, $cd, $ceil, $chan, $chanmodes, $channel, $chantypes, $chat, $chr, $cid, $clevel, $click, $cmdbox, $cmdline, $cnick, $color, $colour, $com, $comcall, $comchan, $comchar, $comerr, $compact, $compress, $comval, $cos, $cosh, $count, $countcs, $cr, $crc, $creq, $crlf, $ctime, $ctimer, $ctrlenter

D $date, $day, $daylight, $dbuh, $dbuw, $dccignore, $dccport, $dde, $ddename, $debug, $decode, $decompress, $deltok, $devent, $dialog, $did, $didreg, $didtok, $didwm, $dir, $disk, $dlevel, $dll, $dllcall, $dname, $dns, $donotdisturb, $dqwindow, $duration

E $ebeeps, $editbox, $email, $emailaddr, $encode, $envvar, $error, $eval, $evalnext, $event, $eventid, $eventparms, $exists, $exiting

F $false, $feof, $ferr, $fgetc, $file, $filename, $filtered, $find, $finddir, $finddirn, $findfile, $findfilen, $findtok, $findtokcs, $fline, $flinen, $floor, $font, $fopen, $fread, $fromeditbox, $fserv, $fserve, $fulladdress, $fulldate, $fullname, $fullscreen

G $get, $getdir, $getdot, $gettok, $gmt, $group

H $halted, $hash, $height, $hfile, $hfind, $hget, $highlight, $hmac $hmatch, $hnick, $host, $hotline, $hotlinepos, $hotlink, $hotp, $hregex, $hypot

I $iaddress, $ial, $ialchan, $ibl, $idle, $iel, $ifmatch, $ifmatch2, $ignore, $iif, $iil, $inellipse, $ini, $initopic, $inmidi, $inmode, $inmp3, $inpaste, $inpoly, $input, $inrect, $inroundrect, $insong, $insongpause, $instok, $int, $intersect, $inwave, $inwho, $ip, $iptype, $iql, $isadmin, $isalias, $isbit, $isdde, $isdir, $isfile, $isid, $islower, $istok, $istokcs, $isupper, $isutf

K $keychar, $keyrpt, $keyval, $knick

L $lactive, $lactivecid, $lactivewid, $left, $leftwin, $leftwincid, $leftwinwid, $len, $level, $lf, $line, $lines, $link, $lock, $locked, $lof, $log, $log10, $logdir, $logstamp, $logstampfmt, $longfn, $longip, $lower, $ltimer

M $maddress, $mask, $matchkey, $matchtok, $matchtokcs, $maxlenl, $maxlenm, $maxlens, $md5, $me, $menu, $menubar, $menucontext, $menutype, $mid, $mididir, $mircdir, $mircexe, $mircini, $mkfn, $mklogfn, $mknickfn, $mnick, $mode, $modefirst, $modelast, $modespl, $mouse, $mousecx, $mousecy, $mousedx, $mousedy, $mousekey, $mouselb, $mousex, $mousey, $mousewin, $mp3, $mp3dir, $msfile, $msgstamp, $msgtags

N $N, $naddress, $network, $newnick, $nhnick, $nick, $nickmode, $no, $nofile, $nopath, $nopnick, $noqt, $not, $notags, $notify, $null, $numeric, $numtok, $nvnick

O $ok, $online, $onlineserver, $onlinetotal $onpoly, $opnick, $or, $ord, $os

P $parmN, $parms, $parseline, $parsetype, $parseutf, $passivedcc, $pi, $pic, $play, $pnick, $portable, $portfree, $pos, $poscs, $prefix, $prop, $protect, $puttok

Q $qt, $query

R $r, $raddress, $rand, $rands, $rawbytes, $rawmsg, $read, $readini, $readn, $regbr, $regerrstr, $regex, $regml, $regmlex, $regsub, $regsubex, $remote, $remove, $removecs, $remtok, $remtokcs, $replace, $replacecs, $replacex, $replacexcs, $reptok, $reptokcs, $result, $rgb, $right, $rnick, $round

S $samepath, $scid, $scon, $script, $scriptdir, $scriptline, $sdir, $send, $server, $serverip, $servertarget, $sfile, $sha1, $sha256, $sha384, $sha512, $shortfn, $show, $signal, $sin, $sinh, $site, $sline, $snick, $snicks, $snotify, $sock, $sockbr, $sockerr, $sockname, $sorttok, $sorttokcs, $sound, $speak, $sqrt, $sreq, $ssl, $sslcertsha1, $sslcertsha256, $sslcertvalid, $ssldll, $ssllibdll, $sslready, $sslversion, $starting, $status, $str, $strip, $stripped, $style, $submenu, $switchbar, $sysdir

T $tan, $tanh, $target, $tempfn, $ticks, $time, $timeout, $timer, $timestamp, $timestampfmt, $timezone, $tip, $tips, $titlebar, $token, $toolbar, $topic, $totp, $treebar, $true, $trust

U $ulevel, $ulist, $unsafe, $upper, $uptime, $url, $usermode, $utfdecode, $utfencode

V $v1, $v2, $var, $vc, $vcmd, $vcmdstat, $vcmdver, $version, $vnick, $vol

W $wavedir, $wid, $width, $wildsite, $wildtok, $wildtokcs, $window, $wrap

X $xor

Y $yes

Z $zip

= =$nick