Difference between revisions of "API File.GetPos"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
Gets the position of the next read or write in the file
 
Gets the position of the next read or write in the file
  
 
<div style="width:25%; float:right" class="toc">
 
<div style="width:25%; float:right" class="toc">
===Class hierarchy===[[API File|File]]
+
====Class hierarchy====
 +
[[API File|File]]
 
:[[API File|GetPos]]
 
:[[API File|GetPos]]
 
</div>
 
</div>
Line 9: Line 10:
  
 
==Parameters==
 
==Parameters==
''[[Variable types|HANDLE]] FileHandle''
+
[[Variable Types|HANDLE]] ''FileHandle''
 
:The handle of an open file
 
:The handle of an open file
 +
  
 
==Return value==
 
==Return value==
[[Variable types|ULONG]]
+
[[Variable Types|ULONG]]
  
 
Returns the position of the next read or write in the file
 
Returns the position of the next read or write in the file
 +
  
 
==Detailed description==
 
==Detailed description==
''No additional information''
+
''<span style="color:red;">No additional information</span>''
 +
 
  
 
==Examples==
 
==Examples==
Line 24: Line 28:
 
* Declare a variable 'result' of type ULONG
 
* Declare a variable 'result' of type ULONG
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.GetPos(filehandle)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.GetPos(filehandle)</pre>
 +
 +
''<span style="color:red;">No additional examples</span>''

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Gets the position of the next read or write in the file

Class hierarchy

File

GetPos

Parameters

HANDLE FileHandle

The handle of an open file


Return value

ULONG

Returns the position of the next read or write in the file


Detailed description

No additional information


Examples

Calling in a calculation

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

No additional examples