gretl_errors

gretl_errors —

Synopsis




void        errmsg                          (int err,
                                             PRN *prn);
const char* errmsg_get_with_default         (int err);
const char* gretl_errmsg_get                (void);
void        gretl_errmsg_set                (const char *str);
void        gretl_error_clear               (void);

Description

Details

errmsg ()

void        errmsg                          (int err,
                                             PRN *prn);

Prints to prn a specific error message if available, otherwise a generic error message corresponding to the given err.

err : gretl error code (see error_codes).
prn : gretl printing struct.

errmsg_get_with_default ()

const char* errmsg_get_with_default         (int err);

err : gretl error code (see error_codes).
Returns : a specific error message if available, otherwise a generic error message corresponding to the given err.

gretl_errmsg_get ()

const char* gretl_errmsg_get                (void);

Returns : a specific error message if available, otherwise an empty string.

gretl_errmsg_set ()

void        gretl_errmsg_set                (const char *str);

If gretl_errmsg is currently blank, copy the given string into the message space; or if the error message is not blank but sufficient space remains, append str to the message.

str : an error message.

gretl_error_clear ()

void        gretl_error_clear               (void);

Blank out any previously recorded error message.