BASS.NET API for the Un4seen BASS Audio LibraryBassSfxBASS_SFX_PluginGetName Method BASS.NET API for the Un4seen BASS Audio Library
Gets the name of a loaded SFX plugin.

Namespace: Un4seen.Bass.AddOn.Sfx
Assembly: Bass.Net (in Bass.Net.dll) Version: 2.4.12.0
Syntax

public static string BASS_SFX_PluginGetName(
	int handle
)

Parameters

handle
Type: SystemInt32
The SFX plugin handle (as obtained by BASS_SFX_PluginCreate(String, IntPtr, Int32, Int32, BASSSFXFlag)).

Return Value

Type: String
If successful, the name of the plugin is returned, else is returned.
Remarks

ERROR CODEDescription
BASS_SFX_ERROR_INITBASS_SFX_Init(IntPtr, IntPtr) has not been successfully called.
BASS_SFX_ERROR_HANDLEInvalid SFX handle.
BASS_SFX_ERROR_MEMMemory error.
BASS_SFX_ERROR_UNKNOWNSome other mystery problem!

Examples

VB
' create a plugin object
Dim sfx As Integer = BassSfx.BASS_SFX_PluginCreate("corona.svp", pictureBox1.Handle, pictureBox1.Width, pictureBox1.Height, BASSSFXFlag.BASS_SFX_DEFAULT)
If sfx <> 0 Then 
    ' get the plugin name
    Console.WriteLine(BassSfx.BASS_SFX_PluginGetName(sfx));
End If
// create a plugin object
int sfx = BassSfx.BASS_SFX_PluginCreate("corona.svp", pictureBox1.Handle, pictureBox1.Width, pictureBox1.Height, BASSSFXFlag.BASS_SFX_DEFAULT);
if (sfx != 0)
{
    // get the plugin name
    Console.WriteLine(BassSfx.BASS_SFX_PluginGetName(sfx));
}
See Also

Reference