Difference between revisions of "API File.SetPos"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
(5 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Sets the position of the next read or write in the file | Sets the position of the next read or write in the file | ||
Line 10: | Line 10: | ||
==Parameters== | ==Parameters== | ||
− | [[Variable | + | [[Variable Types|HANDLE]] ''FileHandle'' |
:The handle of an open file | :The handle of an open file | ||
− | [[Variable | + | [[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 | + | [[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:'' |
− | {| class="wikitable" width=" | + | ::{| class="wikitable" width="65%" |
|- | |- | ||
− | |||
! width="30%" |Name | ! width="30%" |Name | ||
− | ! width=" | + | ! width="55%" |Description |
|- | |- | ||
− | |||
|Seek_Begin | |Seek_Begin | ||
|Position offset is an absolute value | |Position offset is an absolute value | ||
|- | |- | ||
− | |||
|Seek_Curr | |Seek_Curr | ||
|Position offset is relative to the current read/write position | |Position offset is relative to the current read/write position | ||
|- | |- | ||
− | |||
|Seek_End | |Seek_End | ||
|Position offset is relative to the end of the file | |Position offset is relative to the end of the file | ||
|} | |} | ||
+ | |||
==Return value== | ==Return value== | ||
Line 50: | Line 47: | ||
* 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 | + | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<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:
Name Description Seek_Begin Position offset is an absolute value Seek_Curr Position offset is relative to the current read/write position Seek_End Position offset is relative to the end of the file
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 examples