doompanning/external/nng/docs/man/nng_http_res_get_data.3http.adoc
oxmox b3f1d5611f git subtree add --squash -P external/nng https://github.com/nanomsg/nng.git v1.8.0
Merge commit '7063e2102e655079574d6644b323f28f48685c5a' as 'external/nng'
2024-12-18 18:33:08 +01:00

50 lines
1.3 KiB
Text

= nng_http_res_get_data(3http)
//
// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
// Copyright 2018 Capitar IT Group BV <info@capitar.com>
//
// This document is supplied under the terms of the MIT License, a
// copy of which should be located in the distribution where this
// file was obtained (LICENSE.txt). A copy of the license may also be
// found online at https://opensource.org/licenses/MIT.
//
== NAME
nng_http_res_get_data - get HTTP response body
== SYNOPSIS
[source, c]
----
#include <nng/nng.h>
#include <nng/supplemental/http/http.h>
void nng_http_res_get_data(nng_http_res *res, void **bodyp, size_t *sizep);
----
== DESCRIPTION
The `nng_http_res_get_data()` gets the HTTP body associated with
the request _res_, storing a pointer to the buffer at the location referenced
by _bodyp_, and the length of the associated buffer at the location referenced
by _sizep_.
NOTE: The buffer returned is owned by _res_, and will automatically freed
when the request is freed.
== RETURN VALUES
None.
== ERRORS
None.
== SEE ALSO
[.text-left]
xref:nng_http_res_alloc.3http.adoc[nng_http_req_alloc(3http)],
xref:nng_http_res_set_data.3http.adoc[nng_http_req_copy_data(3http)],
xref:nng_http_res_copy_data.3http.adoc[nng_http_req_copy_data(3http)],
xref:nng.7.adoc[nng(7)]