blob: 6a49ddef6139c666d95d3428dd49b181a7bdad2e (
plain) (
tree)
|
|
= cow_cookie:parse_set_cookie(3)
== Name
cow_cookie:parse_set_cookie - Parse a set-cookie header
== Description
[source,erlang]
----
parse_set_cookie(SetCookie :: binary())
-> {ok, Name, Value, Attrs} | ignore
Name :: binary()
Value :: binary()
Attrs :: cow_cookie:cookie_attrs()
----
Parse a set-cookie header.
== Arguments
SetCookie::
The set-cookie header value.
== Return value
An `ok` tuple with the cookie name, value and attributes
is returned on success.
An atom `ignore` is returned when the cookie has both
an empty name and an empty value, and must be ignored.
== Changelog
* *2.9*: Function introduced.
== Examples
.Parse a cookie header
[source,erlang]
----
case cow_cookie:parse_set_cookie(SetCookieHd) of
{ok, Name, Value, Attrs} ->
cookie_engine_set_cookie(Name, Value, Attrs);
ignore ->
do_nothing()
end.
----
== See also
link:man:cow_cookie(3)[cow_cookie(3)],
link:man:cow_cookie:parse_cookie(3)[cow_cookie:parse_cookie(3)],
link:man:cow_cookie:cookie(3)[cow_cookie:cookie(3)],
link:man:cow_cookie:setcookie(3)[cow_cookie:setcookie(3)]
|
