Protocols/MSNP/Activities/SDK/Techref/Objectmodel/Objects/Fileinfo/Properties/Status: 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:06 +01:00 using Anima's CHM converter based on techref/objectmodel/objects/fileinfo/properties/Status.htm --> | ||
{{Protocols/MSNP|section=Activities}} | {{Protocols/MSNP|section=Activities}} | ||
__NOTOC__= | __NOTOC__= [[Protocols/MSNP/Activities/SDK/Techref/Objectmodel/Objects/Fileinfo/Index|Properties]].Status Property = | ||
Returns a <span class="clsEnum">FileStatus</span> enumeration value representing the state of a file transfer. | Returns a <span class="clsEnum">FileStatus</span> enumeration value representing the state of a file transfer. | ||
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 === | ||
An enumeration value describing the state of a file transfer. This value can be <span class="clsEnum">NotStarted</span>, <span class="clsEnum">InProgress</span>, <span class="clsEnum">Cancelled</span>, or <span class="clsEnum">Transferred</span>. If no files are currently being transferred, this property has no value. | An enumeration value describing the state of a file transfer. This value can be <span class="clsEnum">NotStarted</span>, <span class="clsEnum">InProgress</span>, <span class="clsEnum">Cancelled</span>, or <span class="clsEnum">Transferred</span>. If no files are currently being transferred, this property has no value. | ||
VBScript Example | === VBScript Example === | ||
To display the transfer status of a file being transferred, write the value of <span class="clsMethod">FileInfo.Status</span> as shown in the following example. | To display the transfer status of a file being transferred, write the value of <span class="clsMethod">FileInfo.Status</span> as shown in the following example. | ||
| Line 35: | Line 35: | ||
case 2 tdFileStatus.innerHTML = "File transfer cancelled." | case 2 tdFileStatus.innerHTML = "File transfer cancelled." | ||
case 3 tdFileStatus.innerHTML = "File transfer complete." | case 3 tdFileStatus.innerHTML = "File transfer complete." | ||
end select | end select</pre> | ||
</pre> | |||
</div> | </div> | ||
Latest revision as of 01:58, 13 August 2022
Properties.Status Property
Returns a FileStatus enumeration value representing the state of a file transfer.
VBScript Syntax
external.Channel.FileInfo.Status
JavaScript Syntax
window.external.Channel.FileInfo.Status
Property Value
An enumeration value describing the state of a file transfer. This value can be NotStarted, InProgress, Cancelled, or Transferred. If no files are currently being transferred, this property has no value.
VBScript Example
To display the transfer status of a file being transferred, write the value of FileInfo.Status as shown in the following example.
select case myFileTracker.Status
case 0 tdFileStatus.innerHTML = "File transfer not started."
case 1 tdFileStatus.innerHTML = "File transfer in progress."
case 2 tdFileStatus.innerHTML = "File transfer cancelled."
case 3 tdFileStatus.innerHTML = "File transfer complete."
end select