Classes > EffectsMan class > Methods > Effects.CustomDspExternalLoad method

Remarks

Loads a custom DSP from an external dynamic-link library (DLL) file.

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 EffectsMan class.

Syntax

[Visual Basic]

Public Function CustomDspExternalLoad (

strPathname as String

) as Int32

[C#]

public Int32 CustomDspExternalLoad (

string strPathname

);

[C++]

public: Int32 CustomDspExternalLoad (

string strPathname

);

Parameter

Description

strPathname

String representing the filename or absolute pathname of the DLL file containing the custom DSP.

If the string specifies a path but the file does not exist in the specified directory, the function fails. When specifying a path, be sure to use backslashes (\), not forward slashes (/).

If the string does not specify a path, the function uses the standard search strategy of the LoadLibrary Windows API to find the file.

Return value

Value	Meaning

> 0	Numeric value representing the unique identifier of the custom DSP: this unique identifier will be used in order to invoke further methods related to the use of the loaded custom DSP
Negative value	An error occurred: see the LastError property for further error details or for a list of the possible error values.