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

m (Bot: Automated text replacement (-Added On:.+\n?\n?\n?\n?\n? +))
 
(11 intermediate revisions by 4 users not shown)
Line 1: Line 1:
'''$abook''' will return information about nicknames listed inside of the [[mIRC Address Book]].
+
{{mirc title|$abook Identifier}}'''$abook''' will return information about nicknames listed inside of the [[mIRC Address Book]].
 +
 
  
 
== Synopsis ==
 
== Synopsis ==
<pre>$abook(nick,N)</pre>
+
<pre>$abook(nick/N[,N])[.property]</pre>
 
 
== Paramters ==
 
<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 wildcard such as ''ni*'', which would find all nicknames beginning with ''ni''.
 
  
<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.
+
== Parameters ==
 +
* '''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.
  
 
== Properties ==
 
== Properties ==
<span style="display: inline-block; width: 80px;">'''nick'''</span>Returns the nickname attached to the specific address book match.
+
* '''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.
<span style="display: inline-block; width: 80px;">'''info'''</span>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.
<span style="display: inline-block; width: 80px;">'''email'''</span>Returns the email 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.
<span style="display: inline-block; width: 80px;">'''website'''</span>Returns the website URL 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
 
 
<span style="display: inline-block; width: 80px;">'''picture'''</span>Returns the filename of the picture, if any, associated with the address book match.
 
 
 
<span style="display: inline-block; width: 80px;">'''noteN'''</span>Returns the information in the notes area for the address book match.
 
  
 
== Example ==
 
== Example ==
Line 30: Line 26:
  
 
== Compatibility ==
 
== Compatibility ==
Added: mIRC v5.6
+
{{mIRC compatibility|5.6}}
  
 
== See Also ==
 
== See Also ==
Line 36: Line 32:
 
{{mIRC identifier list}}
 
{{mIRC identifier list}}
  
[[Category:MIRC identifiers]]
+
[[Category:mIRC identifiers|abook]]

Latest revision as of 16: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

[Expand]
v · d · e mIRC identifier list