Classes > VSTs class > Methods > VST.EffectFree method

Remarks

Discards from memory a previously loaded VST effect.

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 EffectFree (

nIdVST as Int32

[C#]

public enumErrorCodes EffectFree (

Int32 nIdVST

);

[C++]

public: enumErrorCodes EffectFree (

Int32 nIdVST

);

Parameter	Description

nIdVST	Unique identifier of the VST effect as returned by the VST.Load method. Passing -1 will cause discarding from memory all of the loaded VST effects.

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.