Protocols/MSNP/Activities/SDK/Techref/Objectmodel/Objects/Fileinfo/Properties/Progress: Difference between revisions
Jump to navigation
Jump to search
Animadoria (talk | contribs) (Created automatically by Anima Importer) |
Animadoria (talk | contribs) No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
<!-- Generated @ 08/12/2022 23: | <!-- Generated @ 08/12/2022 23:46:05 +01:00 using Anima's CHM converter based on techref/objectmodel/objects/fileinfo/properties/Progress.htm --> | ||
{{Protocols/MSNP|section=Activities}} | {{Protocols/MSNP|section=Activities}} | ||
__NOTOC__= | __NOTOC__= [[Protocols/MSNP/Activities/SDK/Techref/Objectmodel/Objects/Fileinfo/Index|Properties]].Progress Property = | ||
During a file transfer, returns a <span class="clsUIElement">Long</span> value representing the number of bytes transferred. | During a file transfer, returns a <span class="clsUIElement">Long</span> value representing the number of bytes transferred. | ||
VBScript Syntax | === VBScript Syntax === | ||
<div class="clsCodeIndent"> | <div class="clsCodeIndent"> | ||
| Line 13: | Line 13: | ||
</div> | </div> | ||
JavaScript Syntax | === JavaScript Syntax === | ||
<div class="clsCodeIndent"> | <div class="clsCodeIndent"> | ||
| Line 20: | Line 20: | ||
</div> | </div> | ||
Property Value | === Property Value === | ||
A <span class="clsEnum">Long</span> value representing the number of bytes transferred. If no file is being transferred, returns zero. | A <span class="clsEnum">Long</span> value representing the number of bytes transferred. If no file is being transferred, returns zero. | ||
| Line 35: | Line 35: | ||
testFile = myChannel.FileInfo | testFile = myChannel.FileInfo | ||
document.write( "File transfer in progress, " + testFile.Progress + _ | document.write( "File transfer in progress, " + testFile.Progress + _ | ||
" / " + testFile.Size " bytes transmitted." ) | " / " + testFile.Size " bytes transmitted." )</pre> | ||
</div> | </div> | ||
Remarks | === Remarks === | ||
File progress is updated every 0.5 percent of the total file transfer. This is to provide a reasonable progress bar display without overwhelming the event handler with file progress updates. | File progress is updated every 0.5 percent of the total file transfer. This is to provide a reasonable progress bar display without overwhelming the event handler with file progress updates. | ||
Latest revision as of 01:57, 13 August 2022
Properties.Progress Property
During a file transfer, returns a Long value representing the number of bytes transferred.
VBScript Syntax
external.Channel.FileInfo.Progress
JavaScript Syntax
window.external.Channel.FileInfo.Progress
Property Value
A Long value representing the number of bytes transferred. If no file is being transferred, returns zero.
VBScript Example
To display the progress of a file transfer, write or calculate by using the value of Channel.FileInfo.Progress.
Dim testFile
Set myChannel = external.Channel
testFile = myChannel.FileInfo
document.write( "File transfer in progress, " + testFile.Progress + _
" / " + testFile.Size " bytes transmitted." )
Remarks
File progress is updated every 0.5 percent of the total file transfer. This is to provide a reasonable progress bar display without overwhelming the event handler with file progress updates.