Cookie (Type of variable)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Properties specific to the description of Cookie variables
Functions that use the Cookie variables

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Cookie (Type of variable)

In french: Cookie

The Cookie type is used to handle the cookies transmitted in the HTTP requests. The characteristics of the cookies can be defined and modified by several WLanguage properties.

Remark: See Declaring a variable for more details on the declaration of this type of variable and the use of WLanguage properties.

Example

// Read the cookies of previous session again
MyCookies is array of Cookies
Deserialize(MyCookies, fLoadText("MyCookies.xml"), psdXML)

// Enable the management of cookies
HTTPCookieManage(True)
HTTPCookieReplace(".yahoo.com", MyCookies)

// Request (the cookies will be sent to the Web server)
HTTPRequest("www.yahoo.com")

Remarks

Properties specific to the description of Cookie variables

The following properties can be used to handle a Cookie:

Property name	Type used	Effect

Path	Character string	Validity path of cookie. Indicates to the server the URLs on which the cookie must be interpreted.
Comment	Character string	Free comment value associated with the cookie. This property does not affect the HTTP requests.
Domain	Character string	Validity domain of cookie. The cookie will be sent into all HTTP requests whose domain ends with the validity domain of cookie. For example, a cookie whose validity domain is ".mydomain.fr" will be sent during the following requests: http://mydomain.fr http://www.mydomain.fr/index.html http://server.mydomain.fr/page.awp It will not be sent in the following requests: http://www.mydomain.com http://otherdomain.fr
Expiration	Character string or DateTime variable	Expiration date and time of cookie. In most cases, this property is set by the Web server to avoid retrieving information that is too old in an HTTP request.
Name	Character string	Name of cookie. This name is not case sensitive.
Value	Character string	Value of cookie. Remarks: The value of a cookie is limited to 4KB. Beyond this size, the server is free to reject the cookie. The control characters (TAB, CR, etc.) as well as the semicolon and the binary zeros are not allowed.

Remark: These properties can be used with one of the following syntaxes:

<Variable name>..<Property name>
<Variable name>.<Property name>

Functions that use the Cookie variables


Versions 15 and later HTTPCookieGet New in version 15 HTTPCookieGet HTTPCookieGet	Retrieves the cookies read by a call: to HTTPRequest for an HTTP domain. to HTTPSend for an HTTP domain.
Versions 15 and later HTTPCookieReplace New in version 15 HTTPCookieReplace HTTPCookieReplace	Replaces all the cookies stored for a domain: by HTTPRequest. by HTTPSend.