COM Objects > Effects object > Methods > Effects.CustomDspFree method

Remarks

Discards from memory a previously loaded custom DSP.

For further details about managing a custom DSP effect refer to the How to manage custom DSP 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.CustomDspFree (

nIdDsp as Long

[C++]

short control.Effects.CustomDspFree (

long nIdDsp

);

Parameter	Description

nIdDsp	Unique identifier of the custom DSP to discard from memory as returned by the Effects.CustomDspExternalLoad or by the Effects.CustomDspInternalLoad methods. Passing -1 will cause discarding from memory all of the loaded custom DSPs.

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.