= nng_http_res_del_header(3http)
//
// Copyright 2020 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_del_header - delete HTTP response header

== SYNOPSIS

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

int nng_http_res_del_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

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

== SEE ALSO

[.text-left]
xref:nng_http_res_alloc.3http.adoc[nng_http_res_alloc(3http)],
xref:nng_http_res_add_header.3http.adoc[nng_http_res_add_header(3http)],
xref:nng_http_res_del_header.3http.adoc[nng_http_res_del_header(3http)],
xref:nng_http_res_get_header.3http.adoc[nng_http_res_get_header(3http)],
xref:nng.7.adoc[nng(7)]
