Difference between revisions of "API File.GetPos"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
 
(XML import)
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
wiki page name
+
<sidebar>API Contents</sidebar>
==FileGetPos==
+
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">
----
+
====Class hierarchy====
 +
[[API File|File]]
 +
:[[API File|GetPos]]
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
''[[Variable types|HANDLE]] FileHandle''
+
[[Variable Types|HANDLE]] ''FileHandle''
 
:The handle of an open file
 
:The handle of an open file
  
===Return value===
+
 
[[Variable types|ULONG]]
+
==Return value==
 +
[[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===
 
''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: result = ::File.GetPos(filehandle)
+
* 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