Editing mirc/identifiers/$get

{{mirc title|$get Identifier}}The '''$get''' identifier can be used to gather various details regarding open [[/dcc command - mIRC|DCC Get]] windows, even if the transfers completed.


== Synopsis ==
<pre>$get(N/nick[,N])[.property]</pre>

== Parameters ==
{{ArgsList
| N/nick | Refers to either the Nth open connection, or the connection associated with a specific user's nickname
| [N] | If a nickname is specified in the primary parameter, the secondary N targets the Nth connection associated with that nickname match
}}
<br /><br />

When N = 0, $get(N) returns the total number of all transfers, and $get($nick,N) returns total transfers from $nick.<br />
$get($nick) used without the 2nd N parameter returns $nick if there is at least 1 $get or $null if no transfers.<br />
When N >=1, $get(N) or $get($nick,N) returns the $nick associated with that transfer.<br />
When sender changes nick, the $get is still associated with the old nick unless you use: {{mIRC|/dcc|/dcc nick -sgcf <oldnick> <newnick>}}

'''Note''': $get(-1) can be used during the {{mIRC|on events/on filercvd|ON FILERCVD}} and {{mIRC|on events/on getfail|ON GETFAIL}} events, it refers to the 'get' which triggered that event.

== Properties ==
{{ArgsList
| cid | The connection id
| cps | The characters-per-second transfer rate, averages speed during recent time period until transfer finishes, when rate is averaged across entire connection time
| done | Returns {{mIRC|$true}} if the transfer has completed, otherwise returns {{mIRC|$false}}
| file | The file name of the current transfer
| hwnd | The window handle
| idle | How long since the file transfer has been idle
| ip | The [[IP Address]] for the remote user
| path | The path of the file name being transferred
| pc | The percentage complete for the transfer
| rcvd | The total amount of bytes received so far including the resume offset received during a previous get
| resume | If the transfer has been resumed, returns the location in the file from where the resume took place. Does not offer a way to discern between a transfer not resumed and a transfer resumed at offset zero.
| secs | The total number of seconds the transfer has been connected
| size | The file size in bytes for the transfer
| status | The status of the window; returns: '''sent''', '''active''', '''failed''', '''received''' or '''waiting'''
| wid | The mIRC window id for this window
}}

== Example ==
Echo the total percent completed of the 3rd transfer:
<source lang="mIRC">//echo -a $get(3).pc</source>

Echo the total number of transfers:
<source lang="mIRC">//echo -a $get(0)</source>

Summary of open [[/dcc command - mIRC|DCC Get]] windows:
<pre>//var %i 1 | while ( %i isnum 1- $get(0) ) { echo -a %i nick: $get(%i) file: $get(%i).file size: $get(%i).size status: $get(%i).status | inc %i }</pre>

== Compatibility ==
{{mIRC compatibility|4.52}}

== See Also ==
* {{mIRC|$chat}}
* {{mIRC|$fserve}}
* {{mIRC|$send}}
{{mIRC identifier list}}

[[Category:mIRC identifiers|get]]