COM Objects > Effects object > Methods

Remarks

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

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

strPathname as string

) as Long

[C++]

long control.Effects.VstLoad (

LPCTSTR strPathname

);

Parameter

Description

strPathname

String representing the filename or absolute pathname of the DLL file containing the VST effect.

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 VST effect: this unique identifier will be used in order to invoke further methods related to the use of the loaded VST effect.
0	An error occurred: see the LastError property for further error details or for a list of the possible error values.