FileInterface.SeekG(Variable, Variable) Method

Top

Description

Sets the position of the "Get" pointer by changing its position by the amount specified by offset, referenced from the location specified by offsetType. The Get pointer determines the next location to be read in the buffer associated to the input stream.

Timing Precision Mode

This page describes functionality in nanosecond timing precision mode.

Click here to see the documentation for this object in millisecond timing precision mode.

Method Signature

FileInterface.SeekG(	Variable offset,
	Variable offsetType)

Arguments

offset
Description:	The number of characters to offset the Get pointer position by. If an offset type is not specified, the offset will be applied from the beginning of the file.

offsetType

Description:

Determines where the offset is referenced from.

Valid Values:

Value	Label
0	The offset is applied from the beginning of the stream.
1	The offset is applied from the current position of the Put pointer of the stream.
2	The offset is applied from the end of the stream.

Return Value

Type:

number

Returns the current position of the "Get" pointer, referenced from the beginning of the file.

Syntax

myVariable1 = myFileInterface1.SeekG(myVariable2, myVariable3);