CFCOOKIE

Defines cookie variables, including expiration and security options.

Syntax

<CFCOOKIE NAME="cookie_name"
    VALUE="text"
    EXPIRES="period"
    SECURE="Yes/No"
    PATH="urls"
    DOMAIN=".domain">

NAME

Required. The name of the cookie variable.

VALUE

Optional. The value assigned to the cookie variable.

EXPIRES

Optional. Schedules the expiration of a cookie variable. Can be specified as a date (as in, 10/09/97), number of days (as in, 10, 100), NOW, or NEVER. Using NOW effectively deletes the cookie from the client's browser.

SECURE

Optional. Indicates the variable has to transmit securely. If the browser does not support Secure Socket Layer (SSL) security, the cookie is not sent.

PATH

Optional. Specifies the subset of URLs within the specified domain to which this cookie applies:

PATH="/services/login"

Separate multiple entries with a semicolon ( ; ).

DOMAIN

Specifies the domain for which the cookie is valid and to which the cookie content can be sent. An explicitly specified domain must always start with a dot. This can be a subdomain, in which case the valid domains will be any domain names ending in this string.

For domain names ending in country codes (such as .jp, .us), the subdomain specification must contain at least three periods, for example, .mongo.stateu.us. In the case of special top level domains, only two periods are needed, as in .allaire.com.

When specifying a PATH value, you must include a valid DOMAIN.

Separate multiple entries with a semicolon ( ; ).

Usage

Cookies written with CFCOOKIE do not get written to the cookies.txt file until the browser session ends. Until the browser is closed, the cookie resides in memory. If you do not have an EXPIRES attribute in a CFCOOKIE, the cookie set exists only as long as the client browser is open. When the browser is closed, the cookie expires. It is never written to the cookies.txt file.

Example

<!----------------------------------------------------------- 
This example shows how to set a CFCOOKIE variable, and
shows how to schedule the expiration of the variable.
------------------------------------------------------------->
<HTML>
<HEAD>
<TITLE>
CFCOOKIE Example
</TITLE>
</HEAD>

<CFIF NOT IsDefined("bgcolor")>
    <CFCOOKIE NAME="bgcolor"
        VALUE="white"
        >
<!------------------------------------------------------------ 
If expire is checked, set the cookie's expiration date to NOW. 
--------------------------------------------------------------->
<CFELSEIF IsDefined("Form.Expire")>
    <CFCOOKIE NAME="bgcolor"
    VALUE="FORM.bgcolor"
    EXPIRES="NOW">            
<CFELSE>
      <CFCOOKIE NAME="bgcolor"
        VALUE="FORM.bgcolor"
        EXPIRES="NEVER"
        >
</CFIF>

<CFOUTPUT>
<BODY   bgcolor="#bgcolor#">
</cfoutput>
<H3>CFCOOKIE Example</H3>

<FORM action="cfcookie.cfm" method="post">
If you do not like white, select a color from the following list:<BR>
<SELECT name="bgcolor"> <option value="white">white</option>
                               <option value="gray">grey</option>
                               <option value="green">green</option>
                               <option value="red">red</option>
                               <option value="yellow">yellow</option>
                               <option value="blue">blue</option>
</SELECT>
<BR>Check reset to make the bgcolor cookie expire.<BR>
<INPUT type="Checkbox" name="expire" value="no">
<INPUT type="submit" name="submit" Value= "My Choice">
</FORM>
</BODY>
</HTML>