Methods > Operations > GetSelection method

Remarks

Retrieves the portion of waveform currently selected through the tracker. The current selection can be removed/modified calling the SetSelection method.

Syntax

[Visual Basic]

Public Function GetSelection (

ByRef bSelectionAvailable as Boolean,

ByRef nBeginPosInMs as Int32,

ByRef nEndPosInMs as Int32

) as enumWanErrorCodes

[C#]

public enumWanErrorCodes GetSelection (

ref bool bSelectionAvailable,

ref Int32 nBeginPosInMs,

ref Int32 nEndPosInMs

);

[C++]

public: enumWanErrorCodes GetSelection (

ref bool bSelectionAvailable,

ref Int32 nBeginPosInMs,

ref Int32 nEndPosInMs

);

Parameter

Description

bSelectionAvailable

Reference that, after returning from the method call, will contain the flag for selection availability.

Supported values are the following:

Value	Meaning
false	No selection is currently available
true	A selection is currently available and its limits are stored inside nBeginPosInMs and nEndPosInMs parameters

nBeginPosInMs

Reference that, after returning from the method call, will contain the selection's start position, expressed in milliseconds

nEndPosInMs

Reference that, after returning from the method call, will contain the selection's end position, expressed in milliseconds

Return value

Value	Meaning

Negative value	An error occurred (see the LastError property for further error details)
enumWanErrorCodes.ERR_WAN_NOERROR (0)	The method call was successful