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

(Created $alias identifier - mIRC)
 
m
Line 1: Line 1:
 
'''$alias''' can be used to return the filename of the Nth loaded alias file. If you specify a filename, it returns $null if the file is not loaded; otherwise it returns the file's name.
 
'''$alias''' can be used to return the filename of the Nth loaded alias file. If you specify a filename, it returns $null if the file is not loaded; otherwise it returns the file's name.
  
= Synopsis =
+
== Synopsis ==
 
<pre>$alias(N/filename)</pre>
 
<pre>$alias(N/filename)</pre>
  
= Switches =
+
== Switches ==
 
None
 
None
  
= Parameters =
+
== Parameters ==
 
<span style="display: inline-block; width: 80px;">'''N'''</span>The Nth alias file you want to check. If N is 0, this will return the total number of alias files currently loaded.
 
<span style="display: inline-block; width: 80px;">'''N'''</span>The Nth alias file you want to check. If N is 0, this will return the total number of alias files currently loaded.
  
 
<span style="display: inline-block; width: 80px;">'''filename'''</span>Specify an actual filename if you want to explicitly check if an alias file is loaded. This will return '''$null''' if no file is loaded, otherwise it returns the file name.
 
<span style="display: inline-block; width: 80px;">'''filename'''</span>Specify an actual filename if you want to explicitly check if an alias file is loaded. This will return '''$null''' if no file is loaded, otherwise it returns the file name.
  
= Example =
+
== Example ==
 
'''Echo the total number of alias files currently loaded to the active window'''
 
'''Echo the total number of alias files currently loaded to the active window'''
 
<pre>//echo -a $alias(0)</pre>
 
<pre>//echo -a $alias(0)</pre>
Line 22: Line 22:
 
<pre>//echo -a $alias(myfile.mrc)</pre>
 
<pre>//echo -a $alias(myfile.mrc)</pre>
  
= See also =
+
== See also ==
 
* [[$script identifier - mIRC|$script]]
 
* [[$script identifier - mIRC|$script]]
  
 
[[Category:mIRC identifiers]]
 
[[Category:mIRC identifiers]]

Revision as of 15:31, 23 June 2014

$alias can be used to return the filename of the Nth loaded alias file. If you specify a filename, it returns $null if the file is not loaded; otherwise it returns the file's name.

Synopsis

$alias(N/filename)

Switches

None

Parameters

NThe Nth alias file you want to check. If N is 0, this will return the total number of alias files currently loaded.

filenameSpecify an actual filename if you want to explicitly check if an alias file is loaded. This will return $null if no file is loaded, otherwise it returns the file name.

Example

Echo the total number of alias files currently loaded to the active window

//echo -a $alias(0)

Echo the 3rd alias file name to the active window

//echo -a $alias(3)

Echo if myfile.mrc is currently a loaded alias to the active window

//echo -a $alias(myfile.mrc)

See also