PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
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 define the value of cookies that will be sent to the HTTP server.
  • Versions 20 and later
    WINDEVWEBDEV - Server codeAndroidAndroid Widget iPhone/iPadAjax If the request is run by HTTPSend, HTTPCookieWrite must be run on the httpRequest variable directly (syntax 2).
    New in version 20
    WINDEVWEBDEV - Server codeAndroidAndroid Widget iPhone/iPadAjax If the request is run by HTTPSend, HTTPCookieWrite must be run on the httpRequest variable directly (syntax 2).
    WINDEVWEBDEV - Server codeAndroidAndroid Widget iPhone/iPadAjax If the request is run by HTTPSend, HTTPCookieWrite must be run on the httpRequest variable directly (syntax 2).
Note: 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.
Versions 20 and later
iPhone/iPad This function is now available for the iPhone/iPad applications.
New in version 20
iPhone/iPad This function is now available for the iPhone/iPad applications.
iPhone/iPad This function is now available for the iPhone/iPad applications.
Versions 22 and later
Android This function is now available for the Android applications.
Android Widget This function is now available in Android Widget mode.
New in version 22
Android This function is now available for the Android applications.
Android Widget This function is now available in Android Widget mode.
Android This function is now available for the Android applications.
Android Widget This function is now available in Android Widget mode.
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("ID")
SaveParameter("ID", sID)
Syntax

Request run by HTTPRequest Hide the details

HTTPCookieWrite(<Domain> , <Name> , <Value>)
<Domain>: Character string (with quotes)
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 (with quotes)
Name of cookie.
This name is not case sensitive.
<Value>: Character string (with quotes)
Value of cookie.
Notes:
  • 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.
Versions 20 and later
WINDEVWEBDEV - Server codeAndroidAndroid Widget iPhone/iPadAjax

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 (with quotes)
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 (with quotes)
Name of cookie.
This name is not case sensitive.
<Value>: Character string (with quotes)
Value of cookie.
Notes:
  • 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.
New in version 20
WINDEVWEBDEV - Server codeAndroidAndroid Widget iPhone/iPadAjax

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 (with quotes)
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 (with quotes)
Name of cookie.
This name is not case sensitive.
<Value>: Character string (with quotes)
Value of cookie.
Notes:
  • 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/iPadAjax

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 (with quotes)
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 (with quotes)
Name of cookie.
This name is not case sensitive.
<Value>: Character string (with quotes)
Value of cookie.
Notes:
  • 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.
  • AndroidAndroid Widget This function is available for the devices equipped with ARM processors. A fatal error occurs if this function is used with devices not equipped with ARM processors (x86, mips, ...). This function is available for the devices equipped with ARM processors or using an ARM emulation. Otherwise (and on the Samsung Galaxy Tab 3 tablet), a fatal error will occur.
Components
WINDEVWEBDEV - Server codeReports and Queries wd230com.dll
Windows Mobile wp230com.dll
Linux wd230com.so
Android wd230android.jar
Minimum required version
  • Version 15
This page is also available for…
Comments
Click [Add] to post a comment