ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / WLanguage functions / Communication / HTTP functions
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Adds or modifies a cookie in an HTTP request.
Two types of use are available:
  • If the request is run by HTTPRequest, HTTPCookieWrite must be called before HTTPRequest in order to set the value of cookies that will be sent to the HTTP server.
  • WINDEVWEBDEV - Server codeAndroidAndroid Widget iPhone/iPadIOS WidgetMac CatalystAjax If the request is executed with HTTPSend, HTTPCookieWrite must be executed on the httpRequest variable (syntax 2).
Remark: The cookies read and sent by HTTPRequest are only stored in memory in the application. They are not related to the cookies of Web browsers installed on the computer.
Example
// Sets the value of an identification cookie with a stored value
HTTPCookieWrite("domain.com", "ID", LoadParameter("ID"))
 
// Performs an HTTP request
HTTPRequest("www.MySite.com?Login")
 
// Retrieves and stores the value of the cookie returned by the server
sID is string = HTTPCookieRead(".mysite.com", "ID")
SaveParameter("ID", sID)
Syntax

Request run by HTTPRequest Hide the details

HTTPCookieWrite(<Domain> , <Name> , <Value>)
<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
<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.
WINDEVWEBDEV - Server codeAndroidAndroid Widget iPhone/iPadIOS WidgetMac CatalystAjax

Request run by HTTPSend Hide the details

HTTPCookieWrite(<HTTP request> , <Domain> , <Name> , <Value>)
<HTTP request>: httpRequest variable
Name of httpRequest variable for which the cookie will be set.
<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
<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.
Remarks
  • If the management of cookies was not enabled by HTTPCookieManage, the cookies are not sent to the server:
  • The cookie is created if it does not exist.
Component: wd290com.dll
Minimum version required
  • Version 15
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 05/26/2022

Send a report | Local help