Methods > Operations > SetSelection method

Remarks

Changes the portion of waveform currently selected through the tracker. The current selection, if any, can be retrieved calling the GetSelection method.

After a call to this method the control will fire the WaveAnalyzerSelectionChange event.

Syntax

[Visual Basic]

Public Function SetSelection (

bSelectionAvailable as Boolean,

nBeginPosInMs as Int32,

nEndPosInMs as Int32

) as enumWanErrorCodes

[C#]

public enumWanErrorCodes SetSelection (

bool bSelectionAvailable,

Int32 nBeginPosInMs,

Int32 nEndPosInMs

);

[C++]

public: enumWanErrorCodes SetSelection (

bool bSelectionAvailable,

Int32 nBeginPosInMs,

Int32 nEndPosInMs

);

Parameter

Description

bSelectionAvailable

Flag for selection availability.

Supported values are the following:

Value	Meaning
false	Remove the current selection, if any. In this case values passed through nBeginPosInMs and nEndPosInMs parameters are ignored.
true	Perform a new selection using values stored inside nBeginPosInMs and nEndPosInMs parameters

nBeginPosInMs

The selection's start position, expressed in milliseconds

nEndPosInMs

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