instream-position-method.md

title	description	ms.author	ms.date	ms.tgt_pltfrm	ms.topic	author
InStream.Position([BigInteger]) Method	Get or set the current stream position in seekable streams.	solsen	02/26/2024	na	reference	SusanneWindfeldPedersen

InStream.Position([BigInteger]) Method

Version: Available or changed with runtime version 11.0.

Get or set the current stream position in seekable streams.

Syntax

[StreamPosition := ]  InStream.Position([Length: BigInteger])

Note

This method can be invoked using property access syntax.

Parameters

InStream
 Type: InStream
An instance of the InStream data type.

[Optional] Length
 Type: BigInteger
The stream position to set between 1 and length.

Return Value

[Optional] StreamPosition
 Type: BigInteger
The current stream position or -1 if the stream is not seekable. The actual position will be a positive number from 1 to length.

Remarks

With [!INCLUDE prod_short] 2023 release wave 1, the Position method allows you to get the position within the current stream. Use the InStream.Length() Method to get the position within the current stream.

See Also

InStream Data Type
Getting Started with AL
Developing Extensions