From WikiChip
Editing mirc/identifiers/$get

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

This page supports semantic in-text annotations (e.g. "[[Is specified as::World Heritage Site]]") to build structured and queryable content provided by Semantic MediaWiki. For a comprehensive description on how to use annotations or the #ask parser function, please have a look at the getting started, in-text annotation, or inline queries help pages.

Latest revision Your text
Line 1: Line 1:
{{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.
+
The '''$get''' identifier can be used to gather various details regarding open [[/dcc command - mIRC|DCC Get]] windows.
 
 
  
 
== Synopsis ==
 
== Synopsis ==
Line 10: Line 9:
 
| [N] | If a nickname is specified in the primary parameter, the secondary N targets the Nth connection associated with that nickname match
 
| [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 ==
 
== Properties ==
 
{{ArgsList
 
{{ArgsList
 
| cid | The connection id
 
| 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
+
| cps | The characters-per-second transfer rate
| done | Returns {{mIRC|$true}} if the transfer has completed, otherwise returns {{mIRC|$false}}
+
| done | Returns [[$true identifier - mIRC|$true]] if the transfer has completed, otherwise returns [[$false identifier - mIRC|$false]]
 
| file | The file name of the current transfer
 
| file | The file name of the current transfer
 
| hwnd | The window handle
 
| hwnd | The window handle
| idle | the number of seconds that the file transfer has been idle
+
| idle | How long since the file transfer has been idle
 
| ip | The [[IP Address]] for the remote user
 
| ip | The [[IP Address]] for the remote user
 
| path | The path of the file name being transferred
 
| path | The path of the file name being transferred
 
| pc | The percentage complete for the transfer
 
| 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
+
| rcvd | The total amount of bytes received so far
| 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
+
| resume | If the transfer has been resumed, returns the location in the file from where the resume took place
 
| secs | The total number of seconds the transfer has been connected
 
| secs | The total number of seconds the transfer has been connected
 
| size | The file size in bytes for the transfer
 
| size | The file size in bytes for the transfer
| status | The status of the window; returns: '''sent''', '''active''', '''failed''', '''received''' or '''waiting'''
+
| status | The status of the window; returns: '''active''', or '''inactive'''
 
| wid | The mIRC window id for this window
 
| wid | The mIRC window id for this window
 
}}
 
}}
Line 45: Line 36:
 
<source lang="mIRC">//echo -a $get(0)</source>
 
<source lang="mIRC">//echo -a $get(0)</source>
  
Summary of open [[/dcc command - mIRC|DCC Get]] windows:
+
== Compatibility ==
<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>
+
Added: mIRC v4.52
  
== Compatibility ==
+
Added On: 06/07/96
{{mIRC compatibility|4.52}}
 
  
 
== See Also ==
 
== See Also ==
* {{mIRC|$chat}}
+
* [[$chat identifier - mIRC|$chat]]
* {{mIRC|$fserve}}
+
* [[$fserve identifier - mIRC|$fserve]]
* {{mIRC|$send}}
+
* [[$send identifier - mIRC|$send]]
 
{{mIRC identifier list}}
 
{{mIRC identifier list}}
  
[[Category:mIRC identifiers|get]]
+
[[Category:MIRC identifiers]]

Please note that all contributions to WikiChip may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see WikiChip:Copyrights for details). Do not submit copyrighted work without permission!

Cancel | Editing help (opens in new window)