Remarks
If available, shows/hides or moves the editor (user interface) of the given VST.
Information about the editor can be obtained through the VST.EditorGetInfo method.
For further details about methods related to the use of VST effects refer to the VSTs class.
For further details about managing a VST effect refer to the How to manage VST effects tutorial.
Syntax
[Visual Basic]
Public Function EditorShow (
nPlayerIndex as Int16,
nIdVST as Int32,
bShow as Boolean,
hWndParent as IntPtr,
leftPos as Int32,
topPos as Int32
) as enumErrorCodes
|
|
[C#]
public enumErrorCodes EditorShow (
Int16 nPlayerIndex,
Int32 nIdVST,
bool bShow,
IntPtr hWndParent,
Int32 leftPos,
Int32 topPos
);
|
|
[C++]
public: enumErrorCodes EditorShow (
Int16 nPlayerIndex,
Int32 nIdVST,
bool bShow,
IntPtr hWndParent,
Int32 leftPos,
Int32 topPos
);
|
|
Parameter
|
Description
|
|
|
nPlayerIndex
|
Number representing the zero-based index of the involved player
|
nIdVST
|
Unique identifier of the VST effect as returned by the VST.EffectLoad or VST.InstrumentLoad methods.
|
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.NOERROR (0)
|
The method call was successful.
|
|
