Classes > CustomDSPs class > Methods > CustomDSP.ExternalLoad method

Remarks

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

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

nPlayerIndex as Int16,

strPathname as String

) as Int32

[C#]

public Int32 ExternalLoad (

Int16 nPlayerIndex,

string strPathname

);

[C++]

public: Int32 ExternalLoad (

Int16 nPlayerIndex,

string strPathname

);

Parameter	Description

nPlayerIndex	Number representing the zero-based index of the involved player
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	An error occurred: see the LastError property for further error details or for a list of the possible error values.
Other values	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