Help/file: Reference curl documentation for error codes

Fixes: #27866
This commit is contained in:
Tyler Yankee
2026-06-11 13:47:24 -04:00
parent 36a47953a6
commit 1f32d51dbb

View File

@@ -764,10 +764,16 @@ Transfer
``STATUS <variable>``
Store the resulting status of the operation in a variable.
The status is a ``;`` separated list of length 2.
The status is a
:ref:`semicolon-separated list <CMake Language Lists>` of length 2.
The first element is the numeric return value for the operation,
and the second element is a string value for the error.
A ``0`` numeric error means no error in the operation.
A ``0`` numeric error means no error in the operation (``CURLE_OK``).
The return value and description are produced directly from libcurl.
See the `libcurl documentation`_ on error codes for more information.
.. _`libcurl documentation`: https://curl.se/libcurl/c/libcurl-errors.html
``TIMEOUT <seconds>``
Terminate the operation after a given total time has elapsed.