Copyright © 2011-2018 MultiMedia Soft

Effects.VstEditorShow method

Previous pageReturn to chapter overviewNext page

Remarks

 

If available, shows/hides or moves the editor (user interface) of the given VST effect.

Information about the editor can be obtained through the Effects.VstEditorGetInfo method.

 

For further details about managing a VST effect refer to the How to manage VST effects section.

For further details about methods related to the use of special effects refer to the EffectsMan class.

 

 

Syntax

 

[Visual Basic]

Public Function VstEditorShow (

nIdVST as Int32,

bShow as Boolean,

hWndParent as IntPtr,

leftPos as Int32,

topPos as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes VstEditorShow (

Int32 nIdVST,

bool bShow,

IntPtr hWndParent,

Int32 leftPos,

Int32 topPos

);


 

[C++]

public: enumErrorCodes VstEditorShow (

Int32 nIdVST,

bool bShow,

IntPtr hWndParent,

Int32 leftPos,

Int32 topPos

);


 

 

Parameter

Description

 

 

nIdVST

Unique identifier of the VST effect as returned by the Effects.VstLoad method.

bShow

Show/hide flag.

Supported values are the following:

Value

Meaning

false

Hides the editor window

true

Shows the editor window

hWndParent

Handle of the window (HWND) that will be parent of the editor's window.

leftPos

Left position, respect to the container window client area, expressed in pixels

topPos

Top position, respect to the container window client area, expressed in pixels

 

 

 

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.