Copyright © 2008-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 VST 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 Effects COM object.

 

 

Syntax

 

[Visual Basic]

control.Effects.VstEditorShow (

nIdVST as Long,

bShow as enumBoolean,

hWndParent as OLE_HANDLE,

leftPos as Long,

topPos as Long

) as enumErrorCodes


 

[C++]

short control.Effects.VstEditorShow (

long nIdDsp,

short bShow,

OLE_HANDLE hWndParent,

long leftPos,

long 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

BOOL_FALSE

Hides the editor window

BOOL_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.