Editing mirc/identifiers/$highlight

{{mirc title|$highlight Identifier}}The '''$higlight''' identifier return the number of the line that matched the regular expression in dialog's control.


== Synopsis ==
<pre>$highlight - return $true/$false depending on if highlighting is turned on in the highlight mIRC dialog</pre>


<pre>$highlight(N/text) - return the Nth line in the highlight mIRC dialog's list, or if 'text' is specified, return the line which match 'text'</pre>

== Parameters ==
* '''N''' - if N is passed, return the Nth line in the highlight mIRC dialog's list
* '''text''' - if text is passed,  return the line for which an highlight would trigger for that text

== Properties ==

== Example ==
None

== Compatibility ==
{{mIRC compatibility|5.11}}

== See also ==
{{mIRC identifier list}}

[[Category:mIRC identifiers|highlight]]
@@ Line 1: / Line 1: @@
-{{mirc title|$highlight Identifier}}The '''$highlight''' identifier, if used without parameters, returns a $true/$false value depending on if you have the highlight features enabled in mIRC, otherwise returns informations about the highlight entries.
+{{mirc title|$highlight Identifier}}The '''$higlight''' identifier return the number of the line that matched the regular expression in dialog's control.
@@ Line 6: / Line 6: @@
-<pre>$highlight(N/text) - return the Nth line in the highlight mIRC dialog's list, or return the value of the corresponding entry in mIRC's highlight dialog list, if any, for that string</pre>
+<pre>$highlight(N/text) - return the Nth line in the highlight mIRC dialog's list, or if 'text' is specified, return the line which match 'text'</pre>
 == Parameters ==
 * '''N''' - if N is passed, return the Nth line in the highlight mIRC dialog's list
-* '''text''' - if non-number parameter is passed, return the value of the corresponding entry in mIRC's highlight dialog list in option for that string.
+* '''text''' - if text is passed,  return the line for which an highlight would trigger for that text
 == Properties ==
-* '''.text''' - returns the matching text of the entry
-* '''.color''' - returns the color of the line being highligted
-* '''.sound''' - returns the sound associated with the highlight if any ("beep" or a filename)
-* '''.flash''' - returns 0 if flash is not set, otherwise it returns the corresponding number of repeat time
-* '''.message''' - returns $true/$false depending on if the highlight is set for messages
-* '''.nicks''' - returns $true/$false depending on if the highlight is set for nicks
-* '''.regex''' - returns $true/$false depending on if the text should be compared using a regular expression
-* '''.cs''' - returns $true/$false depending on if the text should be compared using case sensitivity
-* '''.chans''' - returns the list of channels and nicknames required to trigger an highlight for that entry, if any.
 == Example ==