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

effGetErrorText / getErrorText()


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 46:
46. effGetErrorText   >= VST2.0 ... deprecated in VST2.4   @see AudioEffectX::getErrorText()
x[ptr]: returns string-pointer to a string with error text (max 256 bytes)
x[return]: 1 = successful

C++ method:
 bool AudioEffectX::DECLARE_VST_DEPRECATED (getErrorText) (char* text)

Delphi method:
 function AudioEffectX.getErrorText(text: pchar): boolean;
warning:
Please be aware that the string lengths supported by the default VST interface are normally limited to 255 characters (max 254 chars plus null terminating character). If you copy too much data into the buffers provided, you may break certain Host applications.

FIRST   -   PREV   -   NEXT   -   TOP