allegro_error(3alleg)

allegro_error3alleg

Stores the last allegro error message.

Usage

#include <allegro.h>

extern char allegro_error[ALLEGRO_ERROR_SIZE];

Overview

Text string used by set_gfx_mode(), install_sound() and other functions to report error messages. If they fail and you want to tell the user why, this is the place to look for a description of the problem. Example:

   void abort_on_error(const char *message)
   {
      if (screen != NULL)
         set_gfx_mode(GFX_TEXT, 0, 0, 0, 0);
      allegro_message("%s.\nLast Allegro error `%s'\n",
                      message, allegro_error);
      exit(-1);
   }
   ...
      if (some_allegro_function() == ERROR_CODE)
         abort_on_error("Error calling some function!");

Releases

4 releases since Debian 3.1 (Sarge); the text changed 2 times.

  1. 3.1
  2. 4.0
  3. 5.0–6.0

From liballegro-doc 2:4.2.2-2.2 in Debian 6.0 (Squeeze). Parsed by carta from the page's man source.