VST2.4 specs 
HOME   |   Software       VST2.4 specs :: FIRST   -   PREV   -   NEXT

effBeginLoadBank / beginLoadBank()


C++: VstIntPtr function dispatcher(AEffect* e, VstInt32 opcode, VstInt32 index, VstIntPtr value, void* ptr, float opt);
Delphi: function dispatcher(e: PAEffect; opcode, index: VstInt32; value: VstIntPtr; ptr: pointer; opt: Single): VstIntPtr; cdecl;
always returns 0, unless otherwise defined.
all string-pointers points to zero terminated strings.
e[ ]: = plugin receives as entry parameter
x[ ]: = plugin returns to host

dispatcher() function using opcode 75:
75. effBeginLoadBank   >= VST2.3   @see AudioEffectX::beginLoadBank()
Called before a Bank is loaded
e[ptr]: points to VstPatchChunkInfo* structure
x[return]: -1 if the Bank cannot be loaded, 1 if it can be loaded, 0 (for compatibility)

C++ method:
 VstInt32 AudioEffectX::beginLoadBank(VstPatchChunkInfo* ptr)

Delphi method:
 function AudioEffectX.beginLoadBank(ptr: PVstPatchChunkInfo): VstInt32;

VstPatchChunkInfo structure:
 struct VstPatchChunkInfo
 {
  VstInt32 version;         // Format Version (should be 1)
  VstInt32 pluginUniqueID;  // UniqueID of the plug-in
  VstInt32 pluginVersion;   // Plug-in Version
  VstInt32 numElements;     // Number of Programs (Bank) or Parameters (Program)
  char future[48];          // Reserved for future use
 };

FIRST   -   PREV   -   NEXT   -   TOP