3589 return wcs.err->status;
3592In
this example,
if an error was generated in one of the
prjset() functions,
3593wcsperr() would print an error traceback starting with
wcsset(), then
3594celset(), and finally the particular projection-setting function that
3595generated the error. For each of them it would print the status return value,
3596function name, source file, line number, and an error message which may be
3597more specific and informative than the general error messages reported in the
3598first example. For example, in response to a deliberately generated error,
3599the @c twcs test program, which tests
wcserr among other things, produces a
3600traceback similar to this:
3602ERROR 5 in
wcsset() at line 1564 of file wcs.c:
3603 Invalid parameter value.
3604ERROR 2 in
celset() at line 196 of file cel.c:
3605 Invalid projection parameters.
3606ERROR 2 in
bonset() at line 5727 of file prj.c:
3607 Invalid parameters for Bonne's projection.
3610Each of the @ref structs "structs" in @ref overview "WCSLIB" includes a
3611pointer, called @a err, to a
wcserr struct. When an error occurs, a struct is
3612allocated and error information stored in it. The
wcserr pointers and the
3613@ref memory "memory" allocated for them are managed by the routines that
3617example above. If enabled, when an error occurs it is the user's
3618responsibility to free the memory allocated for the error message using
3620out of scope will result in memory leaks (if execution continues beyond the
int celfree(struct celprm *cel)
Destructor for the celprm struct.
int celset(struct celprm *cel)
Setup routine for the celprm struct.
int prjfree(struct prjprm *prj)
Destructor for the prjprm struct.
int bonset(struct prjprm *prj)
Set up a prjprm struct for Bonne's (BON) projection.
int prjset(struct prjprm *prj)
Generic setup routine for the prjprm struct.
Error message handling.
Definition: wcserr.h:243
int wcsfree(struct wcsprm *wcs)
Destructor for the wcsprm struct.
int wcsperr(const struct wcsprm *wcs, const char *prefix)
Print error messages from a wcsprm struct.
int wcsinit(int alloc, int naxis, struct wcsprm *wcs, int npvmax, int npsmax, int ndpmax)
Default constructor for the wcsprm struct.
int wcsset(struct wcsprm *wcs)
Setup routine for the wcsprm struct.
int wcserr_enable(int enable)
Enable/disable error messaging.
int wcsprintf_set(FILE *wcsout)
Set output disposition for wcsprintf() and wcsfprintf().