Copyright © 2008-2018 MultiMedia Soft

Effects.VstProgramParamGetInfo method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains specific information about the given parameter.

 

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

 

 

Syntax

 

[Visual Basic]

Public Function VstProgramParamGetInfo (

nIdVST as Int32,

nProgramIndex as Int16,

nParamIndex as Int16,

nInfo as enumVstParamInfo

) as string


 

[C#]

public string VstProgramParamGetInfo (

Int32 nIdVST,

Int16 nProgramIndex,

Int16 nParamIndex,

enumVstParamInfo nInfo

);


 

[C++]

public: string VstProgramParamGetInfo (

Int32 nIdVST,

Int16 nProgramIndex,

Int16 nParamIndex,

enumVstParamInfo nInfo

);


 

 

Parameter

Description

 

 

nIdVST

Unique identifier of the VST effect as returned by the Effects.VstLoad method.

nProgramIndex

Zero-based index of the program

nParamIndex

Zero-based index of the parameter

nInfo

Type of requested information.

Supported values are the following:

Mnemonic constant

Value

Meaning

VST_PARAM_INFO_NAME

0

VST Parameter Name

VST_PARAM_INFO_LABEL

1

VST Parameter Label

VST_PARAM_INFO_DISPLAY

2

VST Parameter Display

 

 

Return value

 

Value

Meaning

 

 

Empty string

An error occurred (see the LastError property for further error details)

Valid string

String containing the requested information