Copyright © 2006-2018 MultiMedia Soft

WaveformAnalyzer.SnapshotViewGraphicItemsMaskSet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Sets the mask for determining which graphic items will be rendered over the waveform through the WaveformAnalyzer.SnapshotViewDrawToHdc method.

 

For details about graphic items management on the waveform analyzer refer to the How to add graphic items to the Waveform analyzer section.

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 class section.

 

 

Syntax

 

[Visual Basic]

Public Function SnapshotViewGraphicItemsMaskSet (

nGraphicItemsMask as enumGraphicItemMaskValues

) as enumErrorCodes


 

[C#]

public enumErrorCodes SnapshotViewGraphicItemsMaskSet (

enumGraphicItemMaskValues nGraphicItemsMask

);


 

[C++]

public: enumErrorCodes SnapshotViewGraphicItemsMaskSet (

enumGraphicItemMaskValues nGraphicItemsMask

);


 

 

Parameter

Description

 

 

nGraphicItemsMask

Combination of values determining the mask of graphic items that must be drawn. By default all graphic items are enabled for being drawn.

Supported values are the following:

Mnemonic constant

Value

Meaning

MASK_GRAPHIC_ITEM_NONE

0

No graphic item is drawn

MASK_GRAPHIC_ITEM_VERTICAL_LINE

1

Draws vertical lines

MASK_GRAPHIC_ITEM_HORIZONTAL_LINE

2

Draws horizontal lines

MASK_GRAPHIC_ITEM_WAVE_RANGE

4

Draw wave ranges

 

 

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.