Copyright © 2005-2018 MultiMedia Soft

CustomDSP.Free method

Previous pageReturn to chapter overviewNext page

Remarks

 

Discards from memory a previously loaded custom DSP.

 

For further details about methods related to the use of custom DSP effects refer to the CustomDSPs class.

Further information about the use of Custom DSP effects can be found inside the How to manage custom DSP effects tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function Free (

nPlayerIndex as Int16,

nIdDsp as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes Free (

Int16 nPlayerIndex,

Int32 nIdDsp

);


 

[C++]

public: enumErrorCodes Free (

Int16 nPlayerIndex,

Int32 nIdDsp

);


 

 

Parameter

Description

 

 

nPlayerIndex

Number representing the zero-based index of the involved player

nIdDsp

Unique identifier of the custom DSP to discard from memory. 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.NOERROR (0)

The method call was successful.