diff options
| author | Edward Thomson <ethomson@edwardthomson.com> | 2022-02-15 22:55:48 -0500 |
|---|---|---|
| committer | Edward Thomson <ethomson@edwardthomson.com> | 2022-02-22 22:07:44 -0500 |
| commit | 49e180c862dc7c6d1f62a53bf8756e25b3417968 (patch) | |
| tree | bc89a163c8fe5ed8f5db773728ba972544689133 /include | |
| parent | c716b9f295c0a46073f134a23735dd7b811745fe (diff) | |
| download | libgit2-49e180c862dc7c6d1f62a53bf8756e25b3417968.tar.gz | |
errors: expose `git_error_set`
The `git_error_set` function is useful for callers who implement
backends and advanced callbacks. Expose it.
Diffstat (limited to 'include')
| -rw-r--r-- | include/git2/errors.h | 18 |
1 files changed, 16 insertions, 2 deletions
diff --git a/include/git2/errors.h b/include/git2/errors.h index 5a5f8c5a2..62f363507 100644 --- a/include/git2/errors.h +++ b/include/git2/errors.h @@ -130,7 +130,8 @@ GIT_EXTERN(const git_error *) git_error_last(void); GIT_EXTERN(void) git_error_clear(void); /** - * Set the error message string for this thread. + * Set the error message string for this thread, using `printf`-style + * formatting. * * This function is public so that custom ODB backends and the like can * relay an error message through libgit2. Most regular users of libgit2 @@ -143,7 +144,20 @@ GIT_EXTERN(void) git_error_clear(void); * * @param error_class One of the `git_error_t` enum above describing the * general subsystem that is responsible for the error. - * @param string The formatted error message to keep + * @param fmt The `printf`-style format string; subsequent arguments must + * be the arguments for the format string. + */ +GIT_EXTERN(void) git_error_set(int error_class, const char *fmt, ...) + GIT_FORMAT_PRINTF(2, 3); + +/** + * Set the error message string for this thread. This function is like + * `git_error_set` but takes a static string instead of a `printf`-style + * format. + * + * @param error_class One of the `git_error_t` enum above describing the + * general subsystem that is responsible for the error. + * @param string The error message to keep * @return 0 on success or -1 on failure */ GIT_EXTERN(int) git_error_set_str(int error_class, const char *string); |
