Jump to content

API File.GetPos: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import of API auto-gen
Admin (talk | contribs)
XML import
Line 2: Line 2:
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===
: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===
==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''
''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.GetPos(filehandle)</pre>
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.GetPos(filehandle)</pre>

Revision as of 21:14, 11 May 2013

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