summaryrefslogtreecommitdiff
path: root/doc/files_and_dirs.rst
diff options
context:
space:
mode:
authorJörg Frings-Fürst <debian@jff-webhosting.net>2024-10-20 12:21:32 +0200
committerJörg Frings-Fürst <debian@jff-webhosting.net>2024-10-20 12:21:32 +0200
commitdaddaad9c2261547f4ef318efa958e78dddf1c06 (patch)
treecd656f2b0774d5f0cd0be13055220c6ec699f098 /doc/files_and_dirs.rst
parent1c4b96855c415c48c0b3281b801c2e89fb935061 (diff)
parent677e5b0b948fe62d8017c198c57049275f6fe61a (diff)
Update upstream source from tag 'upstream/4.24'
Update to upstream version '4.24' with Debian dir 0cdd704e90221fada3fe68da281545e331045b9b
Diffstat (limited to 'doc/files_and_dirs.rst')
-rw-r--r--doc/files_and_dirs.rst9
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/files_and_dirs.rst b/doc/files_and_dirs.rst
index a18b5a4..a1d7090 100644
--- a/doc/files_and_dirs.rst
+++ b/doc/files_and_dirs.rst
@@ -57,9 +57,15 @@ Operation on directory entries
#include <libHX/io.h>
+ int HX_getcwd(hxmc_t **buf);
int HX_readlink(hxmc_t **buf, const char *path);
int HX_realpath(hxmc_t **buf, const char *path, unsigned int flags);
+``HX_getcwd`` is a length-agnostic version of getcwd. On error, a negative
+integer is returned indicating the errno; the contents of ``*buf`` are
+unspecified if that happens. On success, a non-zero positive integer is
+returned.
+
``HX_readlink`` calls through to readlink to read the target of a symbolic
link, and stores the result in the memory container referenced by ``*buf``
(similar to ``HX_getl`` semantics). If ``*buf`` is ``NULL``, a new container
@@ -91,7 +97,8 @@ actions:
The result is stored in a memory container whose pointer is returned through
``*buf``. The return value of the function will be negative to indicate a
-possible system error, or be positive non-zero for success.
+possible system error, or be positive non-zero for success. The contents of the
+buffer are unspecified in case HX_realpath returns an error.
Operations on directories