Difference between revisions of "API File.GetSize"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
(XML import)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
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====
 +
[[API File|File]]
 +
:[[API 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===
+
 
[[Variable types|ULONG]]
+
==Return value==
 +
[[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===
 
''No additional information''
 
  
===Examples===
+
==Detailed description==
====Calling in a calculation====
+
''<span style="color:red;">No additional information</span>''
 +
 
 +
 
 +
==Examples==
 +
===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>
 +
 
 +
''<span style="color:red;">No additional examples</span>''

Latest revision as of 15:57, 16 January 2014

<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)

No additional examples