From WikiChip
Difference between revisions of "mirc/identifiers/$get"
< mirc‎ | identifiers

(Created $get identifier - mIRC)
 
(Properties)
Line 26: Line 26:
 
| 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: '''active''', or '''inactive'''
 
| status | The status of the window; returns: '''active''', or '''inactive'''
| stamp | Returns either [[$true identifier - mIRC|$true]], or [[$false identifier - mIRC|$false]] depending on if time-stamping is enabled or disabled.
 
 
| wid | The mIRC window id for this window
 
| wid | The mIRC window id for this window
 
}}
 
}}

Revision as of 11:52, 1 July 2014

The $get identifier can be used to gather various details regarding open DCC Get windows.

Synopsis

$get(N/nick[,N])[.property]

Parameters

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

Properties

cid The connection id
cps The characters-per-second transfer rate
done Returns $true if the transfer has completed, otherwise returns $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
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
size The file size in bytes for the transfer
status The status of the window; returns: active, or inactive
wid The mIRC window id for this window

Example

Echo the total percent completed of the 3rd transfer:

//echo -a $get(3).pc

Echo the total number of transfers:

//echo -a $get(0)

Compatibility

Added: mIRC v4.52

Added On: 06/07/96

See Also