Copyright © 2005-2018 MultiMedia Soft

VST.GetInfoString method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains a descriptive information string from the VST.

 

For further details about methods related to the use of VST effects refer to the VSTs class.

For further details about managing a VST effect refer to the How to manage VST effects tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function GetInfoString (

nPlayerIndex as Int16,

nIdVST as Int32,

nInfo as enumVstInfo

) as string


 

[C#]

public string GetInfoString (

Int16 nPlayerIndex,

Int32 nIdVST,

enumVstInfo nInfo

);


 

[C++]

public: string GetInfoString (

Int16 nPlayerIndex,

Int32 nIdVST,

enumVstInfo nInfo

);


 

 

Parameter

Description

 

 

nPlayerIndex

Number representing the zero-based index of the involved player

nIdVST

Unique identifier of the VST effect as returned by the VST.Load method.

nInfo

Index of the requested string.

Supported values are the following:

Mnemonic constant

Value

Meaning

VST_INFO_EFFECT_NAME

0

Friendly name of the VST

VST_INFO_VENDOR_NAME

1

Name of the VST developer/vendor

VST_INFO_PRODUCT_NAME

2

Name of the product

 

 

Return value

 

Value

Meaning

 

 

Empty string

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

Valid string

String containing the requested information