Difference between revisions of "API File.GetSize"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
(XML import)
Line 2: Line 2:
 
Gets the number of bytes in the file, by handle or name
 
Gets the number of bytes in the file, by handle or name
  
 +
<div style="width:25%; float:right" class="toc">
 +
===Class hierarchy===
 +
:File
 +
::GetSize
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
 
''[[Variable types|HANDLE]] Filename''
 
''[[Variable types|HANDLE]] Filename''
 
:The handle or filename to get the size of
 
:The handle or filename to get the size of
  
===Return value===
+
==Return value==
 
[[Variable types|ULONG]]
 
[[Variable types|ULONG]]
  
 
Returns the number of bytes in the file, by handle or name
 
Returns the number of bytes in the file, by handle or name
  
===Detailed description===
+
==Detailed description==
 
''No additional information''
 
''No additional information''
  
===Examples===
+
==Examples==
====Calling in a calculation====
+
===Calling in a calculation===
 
* Declare a variable 'result' of type ULONG
 
* Declare a variable 'result' of type ULONG
* Add to a calculation icon: <pre class="brush:[C]">result = ::File.GetSize(filename)</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.GetSize(filename)</pre>

Revision as of 21:13, 11 May 2013

<sidebar>API contents</sidebar> Gets the number of bytes in the file, by handle or name

Class hierarchy

File
GetSize

Parameters

HANDLE Filename

The handle or filename to get the size of

Return value

ULONG

Returns the number of bytes in the file, by handle or name

Detailed description

No additional information

Examples

Calling in a calculation

  • Declare a variable 'result' of type ULONG
  • Add to a calculation icon:
    result = ::File.GetSize(filename)