Fseek – Visara Master Console Center Scripting Guide User Manual

Page 120

Chapter 5 Script Commands

Scripting Guide

120

FSEEK

Syntax:

FSEEK( %FileNum, %Position) ==> %Success

Description:

Moves an open file’s current record pointer to a byte offset.

Action:

The current record pointer for the file represented by the file handle

FileNum is repositioned to the byte offset specified by the Position
parameter.

Parameters:

%FileNum. Numeric expression. The file handle obtained from

FOPEN(). The file for which the current record pointer will be moved.
%Position. Numeric expression. The number of bytes from the

beginning of the file to position the current record pointer. The
beginning of the file is byte 0.

Returns:

Numeric value, as follows:
Value

Meaning

0 (FALSE)

The current record pointer was not

successfully

moved to the requested

Position.

1 (TRUE)

The current record pointer was

successfully

moved to the requested

Position.

Notes:

N/A

Example:

%Handle := FOPEN( $FileName)
%Success := FSEEK( %Handle, %Position)