Difference between revisions of "API File.SetPos"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
(XML import)
Line 2: Line 2:
 
Sets the position of the next read or write in the file
 
Sets the position of the next read or write in the file
  
 +
<div style="width:25%; float:right" class="toc">
 +
===Class hierarchy===
 +
:File
 +
::SetPos
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
 
''[[Variable types|HANDLE]] FileHandle''
 
''[[Variable types|HANDLE]] FileHandle''
 
:The handle of an open file
 
:The handle of an open file
Line 18: Line 24:
 
|}
 
|}
  
===Return value===
+
==Return value==
 
''This call does not return a value''
 
''This call does not return a value''
  
===Detailed description===
+
==Detailed description==
 
''No additional information''
 
''No additional information''
  
===Examples===
+
==Examples==
====Calling in a calculation====
+
===Calling in a calculation===
* Add to a calculation icon: <pre class="brush:[C]">::File.SetPos(filehandle, address, ::File.Seek_Begin)</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">::File.SetPos(filehandle, address, ::File.Seek_Begin)</pre>

Revision as of 21:14, 11 May 2013

<sidebar>API contents</sidebar> Sets the position of the next read or write in the file

Class hierarchy

File
SetPos

Parameters

HANDLE FileHandle

The handle of an open file

ULONG Address

The position in the file, relative to the From position

BYTE From

A location in the file to offset Address from

Typical values for this parameter:

Return value

This call does not return a value

Detailed description

No additional information

Examples

Calling in a calculation

  • Add to a calculation icon:
    ::File.SetPos(filehandle, address, ::File.Seek_Begin)