2.6. tsGetErrorString

Syntax

Pascal

function tsGetErrorStringA(ErrorCode: tsEnum): pChar;

C/C++

char * tsGetErrorStringA(tsEnum ErrorCode);

Description

Returns a pointer of an nullterminated stringbuffer which contains the text of the given error code.

[Important] Important

These strings are internal constants. So you don't have to free them by yourself.

Params

ErrorCode

For detailed informations about the error code see the return values of tsGetError.

Return Values

The return value is a pointer of an nullterminated stringbuffer. If you pass an wrong errorcode to this function you will get the text of TS_ERROR. Or if the value isn't an errorcode you will get the text of TS_NO_ERROR.