2883 return wcs.err->status;
2886 In
this example,
if an error was generated in one of the
prjset() functions,
2887 wcsperr() would print an error traceback starting with
wcsset(), then
2888 celset(), and finally the particular projection-setting function that
2889 generated the error. For each of them it would print the status return value,
2890 function name, source file, line number, and an error message which may be
2891 more specific and informative than the general error messages reported in the
2892 first example. For example, in response to a deliberately generated error,
2893 the @c twcs test program, which tests
wcserr among other things, produces a
2894 traceback similar to this:
2896 ERROR 5 in wcsset() at line 1564 of file wcs.c:
2897 Invalid parameter value.
2898 ERROR 2 in celset() at line 196 of file cel.c:
2899 Invalid projection parameters.
2900 ERROR 2 in
bonset() at line 5727 of file prj.c:
2901 Invalid parameters for Bonne's projection.
2904 Each of the @ref structs "structs" in @ref overview "WCSLIB" includes a
2905 pointer, called @a err, to a
wcserr struct. When an error occurs, a struct is
2906 allocated and error information stored in it. The
wcserr pointers and the
2907 @ref memory "memory" allocated for them are managed by the routines that
2911 example above. If enabled, when an error occurs it is the user's
2912 responsibility to free the memory allocated for the error message using
2914 out of scope will result in memory leaks (if execution continues beyond the
int wcsfree(struct wcsprm *wcs)
Destructor for the wcsprm struct.
int wcserr_enable(int enable)
Enable/disable error messaging.
Error message handling.
Definition: wcserr.h:221
int prjfree(struct prjprm *prj)
Destructor for the prjprm struct.
int wcsset(struct wcsprm *wcs)
Setup routine for the wcsprm struct.
int celfree(struct celprm *cel)
Destructor for the celprm struct.
int wcsprintf_set(FILE *wcsout)
Set output disposition for wcsprintf() and wcsfprintf().
int wcsperr(const struct wcsprm *wcs, const char *prefix)
Print error messages from a wcsprm struct.
int prjset(struct prjprm *prj)
Generic setup routine for the prjprm struct.
int bonset(struct prjprm *prj)
Set up a prjprm struct for Bonne's (BON) projection.
int wcsini(int alloc, int naxis, struct wcsprm *wcs)
Default constructor for the wcsprm struct.
int celset(struct celprm *cel)
Setup routine for the celprm struct.