Classes > MediaFileDecoderMan class > Methods > MediaFileDecoder.FilePositionGet method

Remarks

Obtains the current position set into the decoded media file. The current position can be modified through the MediaFileDecoder.FilePositionSet method.

For details about management of media files decoding, refer to the How to decode media files tutorial.

Syntax

[Visual Basic]

Public Function FilePositionGet (

ByRef nPosition as Int64,

nPositionUnit as enumDecodePositionUnit

) as Int32

[C#]

public Int32 FilePositionGet (

ref Int64 nPosition,

enumDecodePositionUnit nPositionUnit

);

[C++]

public: Int32 FilePositionGet (

Int64 __gc *nPosition,

enumDecodePositionUnit nPositionUnit

);

Parameter

Description

nPosition

Reference that, on return from the method call, will contain the position expressed in the same unit set into the nPositionUnit parameter below.

nPositionUnit

The unit of measure used for determining the nPosition parameter above.

Supported values are the following:

Mnemonic constant	Value	Meaning
DECODE_POS_UNIT_MS	0	The nPosition parameter is expressed in milliseconds
DECODE_POS_UNIT_BYTES	1	The nPosition parameter is expressed in bytes
DECODE_POS_UNIT_PERCENTAGE	2	The nPosition parameter is expressed in percentage

Return value

Value	Meaning

enumErrorCodes.NOERROR (0)	The method call successful.
Negative value	An error occurred: see the LastError property for further error details or for a list of the possible error values.