summaryrefslogtreecommitdiff
path: root/docs/man/nng_http_res_get_header.adoc
blob: 0d3afbd6617d507bc8376524dc9d6f130fa1fd34 (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_get_header(3)
//
// 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_header - return HTTP response header

== SYNOPSIS

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

const char *nng_http_res_get_header(nng_http_res *res, const char *key);
-----------

== DESCRIPTION

The `nng_http_res_get_header()` looks for an HTTP header _key_ in
the response _res_, and returns the associated value if found,
or `NULL` if not found.

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:` will not find anything.


== RETURN VALUES

HTTP header value for _key_, if it exists, or NULL otherwise.

== ERRORS

None.

== SEE ALSO

<<nng_http_res_alloc#,nng_http_res_alloc(3)>>,
<<nng_http_res_add_header#,nng_http_res_add_header(3)>>,
<<nng_http_res_set_header#,nng_http_res_set_header(3)>>,
<<nng#,nng(7)>>