aboutsummaryrefslogtreecommitdiffstats
path: root/man/zload.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2016-02-29 15:34:38 +0100
committerMattias Andrée <maandree@kth.se>2016-02-29 15:34:38 +0100
commita1a1d9ed137c8e404e7f0bd41804099ef18b9267 (patch)
tree171def711738fa9989a9b040bb264e2cecbda867 /man/zload.3
parentreadme: libzahl is not thread-safe at the moment (diff)
downloadlibzahl-a1a1d9ed137c8e404e7f0bd41804099ef18b9267.tar.gz
libzahl-a1a1d9ed137c8e404e7f0bd41804099ef18b9267.tar.bz2
libzahl-a1a1d9ed137c8e404e7f0bd41804099ef18b9267.tar.xz
Add a number of man pages
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'man/zload.3')
-rw-r--r--man/zload.334
1 files changed, 34 insertions, 0 deletions
diff --git a/man/zload.3 b/man/zload.3
new file mode 100644
index 0000000..86d4213
--- /dev/null
+++ b/man/zload.3
@@ -0,0 +1,34 @@
+.TH ZLOAD 3 libzahl
+.SH NAME
+zload - Unmarshal a big integer from a buffer
+.SH SYNOPSIS
+.nf
+#include <zahl.h>
+
+size_t zload(z_t \fIa\fP, const void *\fIbuf\fP);
+.fi
+.SH DESCRIPTION
+.B zload
+unmarshals a big integer from
+.I buf
+into
+.IR a .
+The big integer should have be saved using
+.BR zsave (3),
+with the same version of libzahl
+and on the processor architecture.
+.P
+.I a
+must have been initialized with
+.BR zinit (3).
+.SH RETURN VALUE
+The number of bytes read from
+.IR buf .
+On failure, 0 is returned.
+.SH ERRORS
+This function may failure for any reason specified for
+.BR realloc (3).
+.SH SEE ALSO
+.BR zinit (3),
+.BR zsave (3),
+.BR zsets (3)