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

m (Additional examples)
Line 1: Line 1:
{{mirc title|$server identifier}}'''$server''' can be used to return the current server name if you don't provide any parameter, or informations about servers in your IRC server list
+
{{mirc title|$server identifier}}'''$server''' can be used to return the current server name if you don't provide any parameter, or informations about servers in your IRC server list if you provide one. You can use $server(-1) to get informations about the current connection without relying on the server list
  
 
== Synopsis ==
 
== Synopsis ==
Line 7: Line 7:
  
 
== Parameters ==
 
== Parameters ==
* '''N/address''' - references the Nth server or use the name you provided, if N = 0, returns total number of server.
+
* '''N/address''' - references the Nth server or use the name you provided, if N = 0, returns total number of server. If N = -1, it identifies the current connection
 
* '''[group]''' - If you specify a group name, returns only servers for that group
 
* '''[group]''' - If you specify a group name, returns only servers for that group
  
 
== Properties ==
 
== Properties ==
 
If parameters are used, you can use the following properties:
 
If parameters are used, you can use the following properties:
* '''.desc''' - returns the description of that server
+
* '''.desc''' - returns the description of that server (returns Random server if N = -1 and you're not connecting using the server list)
 
* '''.pass''' - returns the server password  
 
* '''.pass''' - returns the server password  
* '''.port''' - returns the port parameter
+
* '''.port''' - returns the port parameter (not filled with N = -1 and you're not connecting using the server list)
* '''.group''' - returns the group name
+
* '''.group''' - returns the group name (returns the $network value if N = -1 and you're not connecting using the server list)
 
* '''.method''' - returns the login method (used in conjunction with {{mirc|/server|/server -l}})
 
* '''.method''' - returns the login method (used in conjunction with {{mirc|/server|/server -l}})
 
* '''.methodpass''' - returns the password associated with the login method
 
* '''.methodpass''' - returns the password associated with the login method
 +
* '''.keytype''' - returns the type/mode of the SSL certificate, "global" or "local", depending on if you're using the global certificate or a specific certificate
 +
* '''.key''' - returns the key of the SSL certificate in use
 +
* '''.itype''' - returns the type/mode of the user informations, "global" or "local", depending on if you're using the global user infos (nick, email, ident etc) or specific infos per server (via /server -i or by editing the server list)
 +
* '''.nick''' - return the nickname associated with the connection (editing server list or /server -i), return $null if you connect without the server list and without /server -i
 +
* '''.anick''' - return the alternative nickname associated with the connection (editing server list or /server -i), return $null if you connect without the server list and without /server -i
 +
* '''.email''' - return the email address associated with the connection (editing server list or /server -i), return $null if you connect without the server list and without /server -i
 +
* '''.user''' - return the username associated with the connection (editing server list or /server -i), return $null if you connect without the server list and without /server -i
 +
* '''.encoding''' - return the encoding's ID associated with the connection (editing server list or /server -i), return 0 if you connect without the server list and without /server -encoding
 +
  
 
== Examples ==
 
== Examples ==

Revision as of 20:18, 15 August 2022

$server can be used to return the current server name if you don't provide any parameter, or informations about servers in your IRC server list if you provide one. You can use $server(-1) to get informations about the current connection without relying on the server list

Synopsis

$server
$server(N/address,[group])

Parameters

  • N/address - references the Nth server or use the name you provided, if N = 0, returns total number of server. If N = -1, it identifies the current connection
  • [group] - If you specify a group name, returns only servers for that group

Properties

If parameters are used, you can use the following properties:

  • .desc - returns the description of that server (returns Random server if N = -1 and you're not connecting using the server list)
  • .pass - returns the server password
  • .port - returns the port parameter (not filled with N = -1 and you're not connecting using the server list)
  • .group - returns the group name (returns the $network value if N = -1 and you're not connecting using the server list)
  • .method - returns the login method (used in conjunction with /server -l)
  • .methodpass - returns the password associated with the login method
  • .keytype - returns the type/mode of the SSL certificate, "global" or "local", depending on if you're using the global certificate or a specific certificate
  • .key - returns the key of the SSL certificate in use
  • .itype - returns the type/mode of the user informations, "global" or "local", depending on if you're using the global user infos (nick, email, ident etc) or specific infos per server (via /server -i or by editing the server list)
  • .nick - return the nickname associated with the connection (editing server list or /server -i), return $null if you connect without the server list and without /server -i
  • .anick - return the alternative nickname associated with the connection (editing server list or /server -i), return $null if you connect without the server list and without /server -i
  • .email - return the email address associated with the connection (editing server list or /server -i), return $null if you connect without the server list and without /server -i
  • .user - return the username associated with the connection (editing server list or /server -i), return $null if you connect without the server list and without /server -i
  • .encoding - return the encoding's ID associated with the connection (editing server list or /server -i), return 0 if you connect without the server list and without /server -encoding


Examples

Echo the active connection's server to the active window

//echo -a $server

Echo the number of Dalnet servers in the server list to the active window

//echo -a $server(0,Dalnet)

Echo the domain name of the first server in the Dalnet group in the server list to the active window

//echo -a $server(1,Dalnet)

Compatibility

Added: mIRC v3.5
Added on: 07 Aug 1995
Note: Unless otherwise stated, this was the date of original functionality.
Further enhancements may have been made in later versions.


See Also

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