Editing mirc/identifiers/$chan

{{mirc title|$chan Identifier}}The '''$chan''' identifier is filled during events which trigger on a channel.

The '''$chan''' identifier can also be used to get information regarding a specific channel the local mIRC client is in.

== Synopsis ==
<pre>$chan[(#/N).property]</pre>

== Parameters ==
<span style="display: inline-block; width: 105px;">'''(#/N)'''</span>The specific channel, or channel number referencing the channel.

<span style="display: inline-block; width: 105px;">'''.property'''</span>Get the results of a specific property request for the specified '''channel''' or '''N'''.

== Properties ==
{| class="wikitable" style="margin-left: 75px;"
|-
! Property !! Description
|-
| '''banlist''' || Returns {{mIRC|$true}} if mode +b has been seen already, or {{mIRC|$false}} if not, or  {{mIRC|$inmode}} if currently in a mode +b listing.
|-
| '''cid''' || Returns the connection ID for the channel.
|-
| '''hwnd''' || Returns the [[Operating system|operating system's]] actual [[hWnd|window handle]] for the channel.
|-
| '''ial''' || Returns '''{{mIRC|$true}}''' or '''{{mIRC|$false}}''' if the [Internal address list - mIRC|IAL]] has been updated for the channel.
|-
| '''ibl''' || Returns '''{{mIRC|$true}}''' or '''{{mIRC|$false}}''' if the [[Internal ban list - mIRC|IBL]] has been updated for the channel
|-
| '''idle''' || Returns the amount of time the channel has been idle. This does not include entries made from the local mIRC client.
|-
| '''iel''' || Returns '''{{mIRC|$true}}''' or '''{{mIRC|$false}}''' if the local mIRC client is on the channel's internal exempt list.
|-
| '''iil''' || Returns '''{{mIRC|$true}}''' or '''{{mIRC|$false}}''' if local mIRC client is on the channel's internal invite list.
|-
| '''inwho''' || Returns '''{{mIRC|$true}}''' or '''{{mIRC|$false}}''' if a [[/who command - mIRC|/who command]] has been performed on the channel, and the results are still being processed.
|-
| '''key''' || Returns the channel's key.
|-
| '''limit''' || Returns the amount of users the channel is limited to.
|-
| '''logfile''' || Returns the location of the current channel's [[log file - mIRC|log file]], if any.
|-
| '''mode''' || Returns the current modes set in the channel.
|-
| '''stamp''' || Returns '''{{mIRC|$true}}''' or '''{{mIRC|$false}}''' if [[time stamping - mIRC|time stamping]] is enabled on the channel.
|-
| '''status''' || Returns: '''joining''', '''joined''', or '''kicked'''.
|-
| '''topic''' || Returns the channel topic.
|-
| '''wid''' || Returns the mIRC application's [[window id]] for the channel window.
|}

== Examples ==
Create an alias that opens a [[Custom windows - mIRC|custom @window]] which loads some basic information about the active channel:
<source lang="mIRC">alias getDetails {
  if ($active ischan) {
  var %c = $active
    window @getDetails 350 350 650 200
    clear @getDetails
    echo @getDetails Channel: %c
    echo @getDetails $crlf $crlf
    echo @getDetails Topic: $chan(%c).topic
    echo @getDetails $crlf $crlf
    echo @getDetails Modes: $chan(%c).mode
    echo @getDetails $crlf $crlf
    echo @getDetails Key: $iif($chan(%c).key,$v1,No key set)
  }
}</source>

This [[Aliases - mIRC|custom alias]] can now be executed using the following command in a channel command-line:
<pre>/getDetails</pre>

The results of this command will look similar to the results below:

[[File:$chan identifier example.png|Custom example for the $chan identifier - mIRC]]

== Compatibility ==
{{mIRC compatibility|4.7}}

== See Also ==
* [[On join - mIRC|ON JOIN]]
* [[On part - mIRC|ON PART]]
* {{mIRC|$ial}}
* {{mIRC|$ibl}}
* {{mIRC|$nick}}
{{mIRC identifier list}}

[[Category:MIRC identifiers]]