<nName>
A character string with the name of the cookie.
Method HttpResponseMessage() :getCookie() Foundation
Gets a cookie given its name.
Syntax
:getCookie( <cName> ) --> oCookie
Parameters
Return
:getCookie() returns a DataObject representing the specified cookie. The data object has the members outlined in the following table.
Members of the DataObject returned by :getCookie()
| Name | Data Type | Description |
|---|---|---|
| name | C | Name of the cookie |
| value | C | Value of the cookie |
| expires | C | Expiration date, specified as a datetime value |
| maxAge | N | Maximum lifetime of the cookie, specified in second until the cookie expires. |
| domain | C | Specifies the host domain. Only send this cookie with requests destined for the specified domain. |
| path | C | The URL path of the cookie. Only send this cookie with requests whose request path match (or are a sub-direcory of) the cookie path. |
| sslOnly | L | Only send this cookie for HTTPS connections |
Description
The method :getCookie() gets the specified cookie from the server response. If the same cookie is defined several times (different paths), the first occurance in the response header is returned.
Feedback
If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.