Raptor:Data Logging File Seek: Difference between revisions
No edit summary |
|||
| Line 6: | Line 6: | ||
== Description == | == Description == | ||
<p>This block is used to | <p>This block is used to change the current location of the file accessor in a file. The location is changed relative to the parameter:the start of the file, the current location in a file, or the end of the file. The offset indicates the distance, in bytes, for the location to be changed. It indicates whether or not the position change was successful.</p> | ||
<p>As with many of the other datalogging and file I/O Raptor blocks, this block takes a file handle as an input, and propagates the same file handle through the block logic to an output of the block. By connecting the File Handle output of file I/O block 'X' to the File Handle input of file I/O block 'Y', application designers can ensure that the logic executed by block Y will be performed after the logic executed by block X.</p> | |||
== Inputs == | == Inputs == | ||
| Line 21: | Line 23: | ||
! Offset | ! Offset | ||
| int32 | | int32 | ||
| | | Distance, in bytes, that the current position in the file will move, relative to the 'Seek Relative to' parameter. | ||
|} | |} | ||
Latest revision as of 13:13, 13 September 2023
Return to the main Raptor page
Description
This block is used to change the current location of the file accessor in a file. The location is changed relative to the parameter:the start of the file, the current location in a file, or the end of the file. The offset indicates the distance, in bytes, for the location to be changed. It indicates whether or not the position change was successful.
As with many of the other datalogging and file I/O Raptor blocks, this block takes a file handle as an input, and propagates the same file handle through the block logic to an output of the block. By connecting the File Handle output of file I/O block 'X' to the File Handle input of file I/O block 'Y', application designers can ensure that the logic executed by block Y will be performed after the logic executed by block X.
Inputs
| Input | Type | Description |
|---|---|---|
| File Handle | File Handle | Specifies the file to use. |
| Offset | int32 | Distance, in bytes, that the current position in the file will move, relative to the 'Seek Relative to' parameter. |
Outputs
| Output | Type | Description |
|---|---|---|
| File Handle | File Handle | Outputs the File Handle provided on the input. |
| Success | boolean | Output indicates if the file seek was successful. |
Parameters
| Parameter | Type | Description |
|---|---|---|
| Resource | Specify the resource which contains the file to use. | |
| Seek Relative To | Specify the starting position of the seek: File Start, Current Location, or File End. |