Difference between revisions of "API File.SetPos"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| Line 3: | Line 3: | ||
<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|SetPos]] | :[[API File|SetPos]] | ||
</div> | </div> | ||
| Line 9: | Line 10: | ||
==Parameters== | ==Parameters== | ||
| − | + | [[Variable types|HANDLE]] ''FileHandle'' | |
:The handle of an open file | :The handle of an open file | ||
| − | + | [[Variable types|ULONG]] ''Address'' | |
:The position in the file, relative to the From position | :The position in the file, relative to the From position | ||
| − | + | [[Variable types|BYTE]] ''From'' | |
:A location in the file to offset Address from | :A location in the file to offset Address from | ||
''Typical values for this parameter:'' | ''Typical values for this parameter:'' | ||
| Line 27: | Line 28: | ||
==Detailed description== | ==Detailed description== | ||
| − | ''No additional information'' | + | ''<span style="color:red;">No additional information</span>'' |
| + | |||
==Examples== | ==Examples== | ||
===Calling in a calculation=== | ===Calling in a calculation=== | ||
* Add to a calculation icon: <pre class="brush:[cpp]">::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> | ||
| + | |||
| + | ''<span style="color:red;">No additional information</span>'' | ||
Revision as of 22:11, 11 May 2013
<sidebar>API contents</sidebar> Sets the position of the next read or write in the file
Contents
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)
No additional information
