Navigation:  ThinBASIC Modules > TBASS (Sound Module) > TBASS functions working on init, info, general, ... >

TBASS_ErrorToString

Previous pageReturn to chapter overviewNext page

 

Description

 

Converts the passed TBASS error code to human readable explanative string.

 

Syntax

 

s = TBASS_ErrorToString (nError)

 

Returns

 

String description of the error.

 

Parameters

 

Name

Type

Optional

Meaning

nError

Number

No

Valid TBASS error code, preferably returned by TBASS_ErrorGetCode

 

Remarks

 

For valid TBASS error code, the returned string is in form: "TBASS_ERROR_"(descriptor).

For internal unspecified error, the return value is: "TBASS_ERROR_UNKNOWN"

 

Restrictions

 

If the passed value is outside range of recognisable TBASS error codes, the returned string is in form: "Unknown error ("+format$(nError)+")"

 

See also

 

TBASS_ErrorGetCode,

 

Examples

 

DIM nError AS LONG

...

nError = TBASS_ErrorGetCode

MSGBOX 0, TBASS_ErrorToString(nError)