IM_ERRORMSG

Section: C Library Functions (3)
Updated: 22 April 1991
Index Return to Main Contents
 

NAME

im_error_buffer, im_verror, im_error, im_error_clear, im_warn, im_diag, error_exit - handle error messages from VIPS  

SYNOPSIS

#include <vips/vips.h>

const char *im_error_buffer( void )

void im_verror( const char *domain, const char *fmt, va_list ap )

void im_error( const char *domain, const char *fmt, ... )

void im_error_system( int errno, const char *domain, const char *fmt, ... )

void im_error_clear()

void im_warn( const char *domain, const char *fmt, ... )

void im_diag( const char *domain, const char *fmt, ... )

void error_exit( const char *fmt, ... )

 

DESCRIPTION

im_error(3) formats its arguments as printf and appends the string, with a newline, to the error buffer. The domain argument indicates the error source and should not be marked for translation.

For example, the call:


  im_error( "mystuff", _( "bad argument %d" ), a );

might appear in the error buffer as:


  mystuff: bad argument 12

im_verror(3) works exactly as im_error(3) but takes stdarg arguments.

im_error_system(3) works exactly as im_error(3) but additionally will translate and append a system error code.

im_error_buffer(3) returns a pointer to the start of the error buffer.

im_error_clear(3) empties the error buffer.

error_exit(3) formats its arguments as printf and sends the result to the error output, together with the contents of the error log, before terminating with an error status.

im_warn(3) works as im_error(), but output is sent to the list of warnings.

If an environment variable IM_WARNING exists, messages are suppressed. Warnings should be used for non-critical recoverable errors such as values being clipped.

im_diag(3) works as im_error(), but output is sent to the list of diagnosic errors.

If an environment variable IM_DIAGNOSTICS exists, messages are suppressed. Diagnostics should be used to give extra feedback about the result of the operation.  

SEE ALSO

error_exit(3), im_intro(3).  

COPYRIGHT


Birkbeck College  

AUTHOR

N. Dessipris - 22/04/1991