Remarks
Retrieves the portion of waveform currently selected through the tracker. The current selection can be removed/modified calling the WaveformAnalyzer.SetSelection method.
For details about the use of the Waveform Analyzer refer to the How to use the Waveform Analyzer section.
For further details about methods of the Waveform Analyzer refer to the WaveformAnalyzer object section.
Syntax
[Visual Basic]
control.WaveformAnalyzer.GetSelection (
bSelectionAvailable as enumBoolean,
nBeginPosInMs as Long,
nEndPosInMs as Long
) as enumErrorCodes
|
|
[C++]
short control.WaveformAnalyzer.GetSelection (
long *bSelectionAvailable,
long *nBeginPosInMs,
long *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
|
BOOL_FALSE
|
No selection is currently available
|
BOOL_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)
|
enumErrorCodes.ERR_NOERROR (0)
|
The method call was successful
|
|
