ErrorString -- return a pointer to the API error message

Parent topic: API functions

Format

#include <aopapi.h>
const char*  ErrorString();

Description

The ErrorString function returns a pointer to a string that describes the last error that is returned by the API for the calling thread. The message is a multi-byte string in the language indicated by the current locale when the locale is supported or in English for other locales. These locales are supported: C, En_US, and Ja_JP.

Returned value

ErrorString returns:
  • A pointer to an error string if an error occurred.
  • An empty string if no error occurred.