From d6c6016966cff46d874a8d85b38704a6ef2150e5 Mon Sep 17 00:00:00 2001 From: Russell Belfer Date: Mon, 4 Nov 2013 15:45:31 -0800 Subject: Add giterr_detach API to get and clear error There are a number of cases where it is convenient to be able to fetch and "claim" the current error string, clearing the error. This is helpful when you need to call some code that may alter the error and you want to restore it later on and/or report it via some other mechanism. --- include/git2/errors.h | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'include/git2/errors.h') diff --git a/include/git2/errors.h b/include/git2/errors.h index a454ac956..5f5d0ab1f 100644 --- a/include/git2/errors.h +++ b/include/git2/errors.h @@ -8,6 +8,7 @@ #define INCLUDE_git_errors_h__ #include "common.h" +#include "buffer.h" /** * @file git2/errors.h @@ -45,6 +46,7 @@ typedef struct { /** Error classes */ typedef enum { + GITERR_NONE = 0, GITERR_NOMEMORY, GITERR_OS, GITERR_INVALID, @@ -84,6 +86,21 @@ GIT_EXTERN(const git_error *) giterr_last(void); */ GIT_EXTERN(void) giterr_clear(void); +/** + * Get the last error data and clear it. + * + * This copies the last error message into the given `git_buf` and returns + * the associated `git_error_t`, leaving the error cleared as if + * `giterr_clear` had been called. You must call `git_buf_free` on the + * message to release the memory. + * + * Note: it is possible that this will return `GITERR_NONE` and set the + * buffer to NULL, so be prepared for that condition. Also, if the last + * error was an out-of-memory error, this will return `GITERR_NOMEMORY` + * but also leave the buffer set to NULL (to avoid allocation). + */ +GIT_EXTERN(git_error_t) giterr_detach(git_buf *message); + /** * Set the error message string for this thread. * -- cgit v1.2.1 From 1eab9f0e32178a9aac941583c69e1b9cf9849f77 Mon Sep 17 00:00:00 2001 From: Vicent Marti Date: Tue, 5 Nov 2013 14:56:10 +0100 Subject: error: Simplify giterr_detach --- include/git2/errors.h | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) (limited to 'include/git2/errors.h') diff --git a/include/git2/errors.h b/include/git2/errors.h index 5f5d0ab1f..be7a31d8e 100644 --- a/include/git2/errors.h +++ b/include/git2/errors.h @@ -89,17 +89,14 @@ GIT_EXTERN(void) giterr_clear(void); /** * Get the last error data and clear it. * - * This copies the last error message into the given `git_buf` and returns - * the associated `git_error_t`, leaving the error cleared as if - * `giterr_clear` had been called. You must call `git_buf_free` on the - * message to release the memory. + * This copies the last error into the given `git_error` struct + * and returns 0 if the copy was successful, leaving the error + * cleared as if `giterr_clear` had been called. * - * Note: it is possible that this will return `GITERR_NONE` and set the - * buffer to NULL, so be prepared for that condition. Also, if the last - * error was an out-of-memory error, this will return `GITERR_NOMEMORY` - * but also leave the buffer set to NULL (to avoid allocation). + * If there was no existing error in the library, -1 will be returned + * and the contents of `cpy` will be left unmodified. */ -GIT_EXTERN(git_error_t) giterr_detach(git_buf *message); +GIT_EXTERN(int) giterr_detach(git_error *cpy); /** * Set the error message string for this thread. -- cgit v1.2.1