diff options
| author | Even Rouault <even.rouault@spatialys.com> | 2020-12-15 00:51:44 +0100 |
|---|---|---|
| committer | Even Rouault <even.rouault@spatialys.com> | 2020-12-15 14:59:52 +0100 |
| commit | 54b861e14051a337d473c95389ff7f34c6ee83a8 (patch) | |
| tree | 64fcd59362b2007394706fc36da4d4ba82a124e5 /docs/source/development/reference/functions.rst | |
| parent | 244a24104ded3a4573aeffa32160af21f76cbce6 (diff) | |
| download | PROJ-54b861e14051a337d473c95389ff7f34c6ee83a8.tar.gz PROJ-54b861e14051a337d473c95389ff7f34c6ee83a8.zip | |
Doc: document error codes and proj_context_errno_string()
Diffstat (limited to 'docs/source/development/reference/functions.rst')
| -rw-r--r-- | docs/source/development/reference/functions.rst | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/source/development/reference/functions.rst b/docs/source/development/reference/functions.rst index b37eacdd..5b559d55 100644 --- a/docs/source/development/reference/functions.rst +++ b/docs/source/development/reference/functions.rst @@ -388,6 +388,8 @@ Error reporting context is read. A text representation of the error number can be retrieved with :c:func:`proj_errno_string`. + Consult :ref:`error_codes` for the list of error codes (PROJ >= 8.0) + :param P: Transformation object :type P: :c:type:`PJ` * @@ -400,6 +402,8 @@ Error reporting transformation. A text representation of the error number can be retrieved with :c:func:`proj_errno_string`. + Consult :ref:`error_codes` for the list of error codes (PROJ >= 8.0) + :param ctx: threading context. :type ctx: :c:type:`PJ_CONTEXT` * @@ -464,6 +468,22 @@ Error reporting Get a text representation of an error number. + .. deprecated:: This function is potentially thread-unsafe, replaced by :c:func:`proj_context_errno_string`. + + :param err: Error number. + :type err: `int` + + :returns: `const char*` String with description of error. + +.. c:function:: const char* proj_context_errno_string(PJ_CONTEXT* ctx, int err) + + .. versionadded:: 8.0.0 + + Get a text representation of an error number. + + :param ctx: threading context. + :type ctx: :c:type:`PJ_CONTEXT` * + :param err: Error number. :type err: `int` |
