summaryrefslogtreecommitdiff
path: root/docs/man/nng_http_res_del_header.3http.adoc
blob: 8d2044478867b45da536e65f1813658da11950c1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
= nng_http_res_set_header(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_set_header - set HTTP response header

== SYNOPSIS

[source, c]
----
#include <nng/nng.h>
#include <nng/supplemental/http/http.h>

int nng_http_res_set_header(nng_http_res *res, const char *key);
----

== DESCRIPTION

The `nng_http_res_del_header()` removes all HTTP headers with the
associated _key_ from the response structure _res_.

The value of _key_ is case insensitive, and should not include the final
colon in an HTTP header.  For example, specifying `Host` or `hOSt` are
equivalent, whereas the value `Host:` is not a legal header key.

== RETURN VALUES

This function returns 0 on success, and non-zero otherwise.

== ERRORS

`NNG_ENOENT`:: No header with the key _key_ was present.
`NNG_ENOTSUP`:: No support for HTTP in the library.

== SEE ALSO

<<nng_http_res_alloc.3http#,nng_http_res_alloc(3http)>>,
<<nng_http_res_add_header.3http#,nng_http_res_add_header(3http)>>,
<<nng_http_res_del_header.3http#,nng_http_res_del_header(3http)>>,
<<nng_http_res_get_header.3http#,nng_http_res_get_header(3http)>>,
<<nng.7#,nng(7)>>