Name

Description

const char *
Vix_GetErrorText(VixError err,
                 const char *locale);

Returns a human-readable string that describes the error.

Parameters

err

A Vix error code returned by any other Vix function.

locale

Must be NULL.

Return Value

Remarks

• This translates an error code, which is an enumerated type, to a user-readable string.
• The returned string is a constant string. Do not try to free it by calling Vix_FreeBuffer().
• The locale is not used, and must be NULL. Only U.S. English is supported in this release.

Requirements