CookieWrite (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Limits
Miscellaneous

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

CookieWrite (Function)

In french: CookieEcrit

Writes a cookie onto the computer of the Web user.

The cookie is written during the next display of a WEBDEV page in the browser.

The cookie is written onto the computer of the Web user.

Example

See additional examples

// -- Click on a BTN_Validate button (server code)
// Create a cookie: save the user name
// and the date of last visit
CookieWrite("NAME_AND_DATE", Name + "," + DateSys())
PageDisplay(PAGE_Purchases)

// -- Click on a BTN_Save button (browser code)
// Create a cookie: save the search options
CookieWrite("SEARCHOPT", Keyword + "," + ByIDENTICAL)

Syntax

CookieWrite(<Cookie name> , <Cookie value> [, <Validity period> [, <Path> [, <Domain> [, <Type of cookie>]]]])

<Cookie name>: Character string (with quotes)

Name of the cookie that must be written onto the computer of the Web user. This name can be used during the call to CookieRead.
Caution: The ";" character cannot be used in the name of the cookie.

<Cookie value>: Character string (with quotes)

Value of the cookie to write onto the computer of the Web user. This value can be a list of data, various information, ... The maximum size of the character string cannot exceed 4000 characters.
Caution: The ";" character and the "Carriage Return" (CR) character cannot be used in the value of the cookie.

<Validity period>: Optional integer

Number of days during which the cookie is valid. Once this number of days is exceeded, the cookie is automatically deleted from the computer of the Web user. The cookie is valid for 30 days by default.

<Path>: Optional character string (with quotes)

Versions 20 and later
Path for which the cookie must be saved. This path must exist on the server. This parameter is case-sensitive.
By default (or if this parameter corresponds to an empty string), the path corresponds to "/".
Example: "/COOKIES_WEB/FR/LOGIN"
New in version 20
Path for which the cookie must be saved. This path must exist on the server. This parameter is case-sensitive.
By default (or if this parameter corresponds to an empty string), the path corresponds to "/".
Example: "/COOKIES_WEB/FR/LOGIN"
Path for which the cookie must be saved. This path must exist on the server. This parameter is case-sensitive.
By default (or if this parameter corresponds to an empty string), the path corresponds to "/".
Example: "/COOKIES_WEB/FR/LOGIN"

<Domain>: Optional character string (with quotes)

Versions 20 and later
Domain for which the cookie must be saved.
If this parameter is not specified or if it corresponds to an empty string, the domain corresponds to the current domain. The cookie will be associated with this domain only.
If this parameter explicitly corresponds to a domain name, the cookie will be associated with the specified domain name and with all its sub-domains.
New in version 20
Domain for which the cookie must be saved.
If this parameter is not specified or if it corresponds to an empty string, the domain corresponds to the current domain. The cookie will be associated with this domain only.
If this parameter explicitly corresponds to a domain name, the cookie will be associated with the specified domain name and with all its sub-domains.
Domain for which the cookie must be saved.
If this parameter is not specified or if it corresponds to an empty string, the domain corresponds to the current domain. The cookie will be associated with this domain only.
If this parameter explicitly corresponds to a domain name, the cookie will be associated with the specified domain name and with all its sub-domains.

<Type of cookie>: Optional Integer constant (or combination of constants)

Versions 21 and later
Type of cookie to write:
cookieHTTPOnly Cookie that can be retrieved in server code only. This cookie cannot be read in browser code.
This constant is not available.
cookieNormal
(Default value) Cookie without specific options.
This constant cannot be combined with the other constants.
Versions 25 and later
cookieSameSiteStrict
New in version 25
cookieSameSiteStrict
cookieSameSiteStrict SameSite cookie. This type of cookie is used to prevent Cross Site Request Forgery (CSRF) attacks.
This constant is only available from version 25 Update 2.
cookieSecure Cookie transmitted in an HTTPS request only.
New in version 21
Type of cookie to write:
cookieHTTPOnly Cookie that can be retrieved in server code only. This cookie cannot be read in browser code.
This constant is not available.
cookieNormal
(Default value) Cookie without specific options.
This constant cannot be combined with the other constants.
Versions 25 and later
cookieSameSiteStrict
New in version 25
cookieSameSiteStrict
cookieSameSiteStrict SameSite cookie. This type of cookie is used to prevent Cross Site Request Forgery (CSRF) attacks.
This constant is only available from version 25 Update 2.
cookieSecure Cookie transmitted in an HTTPS request only.
Type of cookie to write:
cookieHTTPOnly Cookie that can be retrieved in server code only. This cookie cannot be read in browser code.
This constant is not available.
cookieNormal
(Default value) Cookie without specific options.
This constant cannot be combined with the other constants.
Versions 25 and later
cookieSameSiteStrict
New in version 25
cookieSameSiteStrict
cookieSameSiteStrict SameSite cookie. This type of cookie is used to prevent Cross Site Request Forgery (CSRF) attacks.
This constant is only available from version 25 Update 2.
cookieSecure Cookie transmitted in an HTTPS request only.

Remarks

Limits

The maximum size of a cookie cannot exceed 4000 characters. Up to 20 cookies can be written per domain.
A single cookie can be written per page.
Reminder: When the Web user connects to a WEBDEV site, the Web server loads all the cookies associated with the current domain in memory.
Remark: The Internet domain corresponds to a specific section of the Internet address: http://computer.domain.com/MyPages/Index.html.

Miscellaneous

Some browsers give you the ability to disable the cookies. In this case, CookieWrite has no effect.
If the name or the value of your cookie contains special characters (* for example), accented or UNICODE, the writing of the cookie may have no effect with some browsers.

Component: wd260page.dll