about summary refs log tree commit diff
path: root/man/libhttpc_dumpresponse.3
diff options
context:
space:
mode:
authorNakidai <nakidai@disroot.org>2024-12-15 00:40:10 +0300
committerNakidai <nakidai@disroot.org>2024-12-15 00:44:26 +0300
commit0e8ee9387620ba232003d297a1a2f7f21000e63f (patch)
tree5cef94cc1a9c6e7490d9ed3dbb0a02afe695bb84 /man/libhttpc_dumpresponse.3
parentf611496625b0b240a8b849afabcfef9d373fa868 (diff)
downloadlibhttpc-0e8ee9387620ba232003d297a1a2f7f21000e63f.tar.gz
libhttpc-0e8ee9387620ba232003d297a1a2f7f21000e63f.zip
Document new feature of LibHTTPC_dumpResponse v1.1.0
Diffstat (limited to 'man/libhttpc_dumpresponse.3')
-rw-r--r--man/libhttpc_dumpresponse.342
1 files changed, 41 insertions, 1 deletions
diff --git a/man/libhttpc_dumpresponse.3 b/man/libhttpc_dumpresponse.3
index 81074ec..9136188 100644
--- a/man/libhttpc_dumpresponse.3
+++ b/man/libhttpc_dumpresponse.3
@@ -1,4 +1,4 @@
-.Dd December 14, 2024
+.Dd December 15, 2024
 .Dt LIBHTTPC_DUMPRESPONSE 3
 .Os
 .
@@ -29,6 +29,14 @@ contents of
 .Fa response
 in the
 .Fa buf .
+If
+.Fa buf
+is equal to
+.Dv NULL ,
+then function will
+allocate buffer
+itself using
+.Xr libhttpc-alloc 3 .
 .
 .Pp
 .Fn LibHTTPC_writeResponse
@@ -62,6 +70,38 @@ be set to
 .Fn LibHTTPC_dumpStatus status .
 .
 .Sh RETURN VALUES
+.Fn LibHTTPC_dumpResponse
+will return pointer
+to the buffer
+on success.
+If function returned
+.Dv NULL ,
+it could mean
+either:
+.Bl -bullet
+.It
+If
+.Xr errno 3
+is 0
+(Success),
+it means that
+user hadn't set
+.Xr libhttpc-alloc 3 .
+.It
+If
+.Xr errno 3
+is not 0,
+it means that
+.Fn LibHTTPC_malloc
+has failed
+to allocate buffer.
+Read
+.Ql ERRORS
+section of
+.Ql malloc 3
+for more information.
+.El
+.
 .Fn LibHTTPC_writeResponse
 will return 1
 if cannot send