Semiconductor & Computer Engineering
m |
m (→Synopsis: Replace / with |, match helpfile.) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{mirc title|$protect Identifier}}'''$protect''' | + | {{mirc title|$protect Identifier}}The '''$protect''' identifier allows you to get data from your [[/protect command - mIRC|Auto-protect]] list in mIRC. |
== Synopsis == | == Synopsis == | ||
| − | <pre>$protect</pre> | + | <pre>$protect |
| + | $protect(address|N)[.property]</pre> | ||
| + | |||
| + | '''Note:''' $protect by itself returns ''$true'' if auto-protect is enabled, otherwise it returns ''$false''. | ||
== Parameters == | == Parameters == | ||
| − | + | <span style="display: inline-block; width: 80px;">'''address'''</span>Returns any match based on the specified address from the auto-protect list. | |
| + | |||
| + | <span style="display: inline-block; width: 80px;">'''N'''</span>Returns any match in the auto-protect list based on the Nth entry in the list. If N is 0, the total amount of addresses in the auto-protect list will be returned. | ||
== Properties == | == Properties == | ||
| − | + | <span style="display: inline-block; width: 80px;">'''type'''</span>If a match is found, returns the list of channels associated with its auto-protect. | |
| + | |||
| + | <span style="display: inline-block; width: 80px;">'''network'''</span>Returns which network the auto-protect is associated with. | ||
| − | == | + | == Examples == |
| + | '''Echo to the active window whether or not auto-protect is enabled''' | ||
<source lang="mIRC">//echo -a $protect</source> | <source lang="mIRC">//echo -a $protect</source> | ||
| + | |||
| + | '''Echo to the active window the total number of addresses in the auto-protect list''' | ||
| + | <source lang="mIRC">//echo -a $protect(0)</source> | ||
| + | |||
| + | '''Echo to the active window the network that the match is associated with''' | ||
| + | <source lang="mIRC">//echo -a $protect(*testhost.com).network</source> | ||
== Compatibility == | == Compatibility == | ||
| − | {{mIRC compatibility|5. | + | {{mIRC compatibility|5.9}} |
| − | == See | + | == See Also == |
| + | * {{mIRC|$avoice}} | ||
| + | * {{mIRC|$auto}} | ||
* {{mIRC|/protect}} | * {{mIRC|/protect}} | ||
| + | * {{mIRC|/avoice}} | ||
| + | * {{mIRC|/ignore}} | ||
| + | * {{mIRC|/pop}} | ||
| + | * {{mIRC|/pvoice}} | ||
{{mIRC identifier list}} | {{mIRC identifier list}} | ||
| + | |||
[[Category:mIRC identifiers|protect]] | [[Category:mIRC identifiers|protect]] | ||
Latest revision as of 11:03, 26 November 2024
The $protect identifier allows you to get data from your Auto-protect list in mIRC.
Synopsis[edit]
$protect $protect(address|N)[.property]
Note: $protect by itself returns $true if auto-protect is enabled, otherwise it returns $false.
Parameters[edit]
addressReturns any match based on the specified address from the auto-protect list.
NReturns any match in the auto-protect list based on the Nth entry in the list. If N is 0, the total amount of addresses in the auto-protect list will be returned.
Properties[edit]
typeIf a match is found, returns the list of channels associated with its auto-protect.
networkReturns which network the auto-protect is associated with.
Examples[edit]
Echo to the active window whether or not auto-protect is enabled
//echo -a $protect
Echo to the active window the total number of addresses in the auto-protect list
//echo -a $protect(0)
Echo to the active window the network that the match is associated with
//echo -a $protect(*testhost.com).network
Compatibility[edit]
Added: mIRC v5.9
Added on: 26 Apr 2001
Note: Unless otherwise stated, this was the date of original functionality.
Further enhancements may have been made in later versions.