Difference between revisions of "API File.SetPos"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
|||
| (18 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | == | + | |- |
| − | + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | |
| − | Sets the position of the next read or write in the file | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetPos''' |
| − | ---- | + | |- |
| − | + | | colspan="2" | Sets the position of the next read or write in the file | |
| − | === | + | |- |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | |
| + | | width="90%" | FileHandle | ||
| + | |- | ||
| + | | colspan="2" | The handle of an open file | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG | ||
| + | | width="90%" | Address | ||
| + | |- | ||
| + | | colspan="2" | The position in the file, relative to the From position | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | From | ||
| + | |- | ||
| + | | colspan="2" | A location in the file to offset Address from | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| − | |||
| − | |||
| − | + | ==Detailed description== | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | ==Examples== | |
| − | + | ===Calling in a calculation=== | |
| − | * Add to a calculation icon: ::File.SetPos(filehandle, address, ::File.Seek_Begin) | + | * Add to a calculation icon: <pre class="brush:[cpp]">::File.SetPos(filehandle, address, ::File.Seek_Begin)</pre> |
Latest revision as of 11:55, 16 January 2023
|
SetPos |
| Sets the position of the next read or write in the file | |
 - 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 | |
 - NONE
|
Return |
Detailed description
Examples
Calling in a calculation
- Add to a calculation icon:
::File.SetPos(filehandle, address, ::File.Seek_Begin)
