MACROMEDIA COLFUSION MX 7-CFML Reference

Brand: MACROMEDIA

Model: COLFUSION MX 7-CFML

Category: Software

Type: Reference

This manual is also suitable for

COLFUSION MX 7

COLDFUSION

MX 7

CFML Reference

Trademarks

1 Step RoboPDF, ActiveEdit, ActiveTest, Authorware, Blue Sky Software, Blue Sky, Breeze, Breezo, Captivate, Central,

ColdFusion, Contribute, Database Explorer, Director, Dreamweaver, Fireworks, Flash, FlashCast, FlashHelp, Flash Lite,

FlashPaper, Flex, Flex Builder, Fontographer, FreeHand, Generator, HomeSite, JRun, MacRecorder, Macromedia, MXML,

RoboEngine, RoboHelp, RoboInfo, RoboPDF, Roundtrip, Roundtrip HTML, Shockwave, SoundEdit, Studio MX, UltraDev,

and WebHelp are either registered trademarks or trademarks of Macromedia, Inc. and may be registered in the United States or

in other jurisdictions including internationally. Other product names, logos, designs, titles, words, or phrases mentioned within

this publication may be trademarks, service marks, or trade names of Macromedia, Inc. or other entities and may be registered in

certain jurisdictions including internationally.

This product includes code licensed from RSA Data Security.

Third-Party Information

This guide contains links to third-party websites that are not under the control of Macromedia, and Macromedia is not

responsible for the content on any linked site. If you access a third-party website mentioned in this guide, then you do so at your

own risk. Macromedia provides these links only as a convenience, and the inclusion of the link does not imply that Macromedia

endorses or accepts any responsibility for the content on those third-party sites.

photocopied, reproduced, translated, or converted to any electronic or machine-readable form in whole or in part without

written approval from Macromedia, Inc. Notwithstanding the foregoing, the owner or authorized user of a valid copy of

the software with which this manual was provided may print out one copy of this manual from an electronic version of this

manual for the sole purpose of such owner or authorized user learning to use such software, provided that no part of this

manual may be printed out, reproduced, distributed, resold, or transmitted for any other purposes, including, without

limitation, commercial purposes, such as selling copies of this documentation or providing paid-for support services.

Part Number ZCF70M600

Acknowledgments

Project Management: Randy Nielsen

Writing: Hal Lichtin, Randy Nielsen

Editing: Linda Adler, Noreen Maher

Production Management: Patrice O’Neill,

Media Design and Production: John Francis, Adam Barnett

First Edition: January 2005

Macromedia, Inc.

600 Townsend St.

San Francisco, CA 94103

CONTENTS

INTRODUCTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

CHAPTER 1: Reserved Words and Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Reserved words . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Scope-specific built-in variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Custom tag variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

ColdFusion tag-specific variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Standard CGI variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

CGI environment variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

CHAPTER 2: ColdFusion Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Tags by function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Tag changes since ColdFusion 5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

CHAPTER 3: ColdFusion Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449

Functions by category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452

Function changes since ColdFusion 5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457

CHAPTER 4: ColdFusion MX Flash Form Style Reference . . . . . . . . . . . . . . . . 933

Styles valid for all controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934

Styles for cfform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 936

Styles for cfformgroup with horizontal or vertical type atributes . . . . . . . . . . . . . 936

Styles for box-style cfformgroup elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 937

Styles for cfformgroup with accordion type attribute . . . . . . . . . . . . . . . . . . . . . . 938

Styles for cfformgroup with tabnavigator type attribute . . . . . . . . . . . . . . . . . . . . 939

Styles for cfformitem with hrule or vrule type attributes . . . . . . . . . . . . . . . . . . . 939

Styles for cfinput with radioButton, checkbox, button, image,

or submit type attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 940

Styles for cftextarea tag and cfinput with text, password,

or hidden type attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 941

Styles for cfselect with size attribute value of 1. . . . . . . . . . . . . . . . . . . . . . . . . . . 941

Styles for cfselect with size attribute value greater than 1 . . . . . . . . . . . . . . . . . . . 942

Styles for cfcalendar tag and cfinput with dateField type attribute . . . . . . . . . . . . 942

Styles for the cfgrid tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 943

Styles for the cftree tag. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 943

4 Contents

CHAPTER 5: Application.CFC Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 945

Application variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 945

Method summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 946

CHAPTER 6: ColdFusion MX Event Gateway Reference . . . . . . . . . . . . . . . . . . 963

Gateway development interfaces and classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 963

CFML CFEvent structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1004

IM gateway methods and commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1004

SMS Gateway CFEvent structure and commands . . . . . . . . . . . . . . . . . . . . . . . 1042

CHAPTER 7: ColdFusion C++ CFX Reference . . . . . . . . . . . . . . . . . . . . . . . . . 1055

C++ class overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1055

Deprecated class methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1056

CCFXException class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1056

CCFXQuery class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1058

CCFXRequest class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1062

CCFXStringSet class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1072

CHAPTER 8: ColdFusion Java CFX Reference . . . . . . . . . . . . . . . . . . . . . . . . 1075

Class libraries overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1075

Custom tag interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1076

Query interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1077

Request interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1082

Response interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1087

Debugging classes reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1090

CHAPTER 9: WDDX JavaScript Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1091

JavaScript object overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1091

WddxSerializer object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1092

WddxRecordset object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1095

CHAPTER 10: ColdFusion ActionScript Functions. . . . . . . . . . . . . . . . . . . . . . 1101

INTRODUCTION

CFML Reference is your primary ColdFusion Markup Language (CFML) reference. Use this

manual to learn about CFML tags and functions, ColdFusion expressions, and using JavaScript

objects for WDDX in Macromedia ColdFusion MX 7. It also provides detailed references for Java

and C++ CFX interfaces.

About Macromedia ColdFusion MX documentation

The ColdFusion MX documentation is designed to provide support for the complete spectrum of

participants.

Documentation set

The ColdFusion documentation set includes the following titles:

Manual Description

Installing and Using

ColdFusion MX

Describes system installation and basic configuration for Windows, Solaris,

Linux, and HP-UX.

Configuring and

Administering

ColdFusion MX

Part I describes how to manage the ColdFusion environment, including

connecting to your data sources and configuring security for your

applications. Part II describes Verity search tools and utilities that you can

use for configuring the Verity K2 Server search engine, as well as creating,

managing, and troubleshooting Verity collections.

ColdFusion MX

Developer’s Guide

Describes how to develop your dynamic web applications, including

retrieving and updating your data, and using structures and forms.

Getting Started

Building

ColdFusion MX

Applications

Contains an overview of ColdFusion features and application development

procedures. Includes a tutorial that guides you through the process of

developing an example ColdFusion application.

CFML Reference Provides descriptions, syntax, usage, and code examples for all ColdFusion

tags, functions, and variables.

CFML Quick Reference A brief guide that shows the syntax of ColdFusion tags, functions, and

variables.

6 Introduction:

Viewing online documentation

All ColdFusion MX documentation is available online in HTML and Adobe Acrobat Portable

Document Format (PDF) files. Go to the documentation home page for ColdFusion MX on the

Macromedia website: www.macromedia.com.

CHAPTER 1

Reserved Words and Variables

This chapter provides information on Macromedia ColdFusion reserved words, and lists scope

variables.

Contents

Reserved words . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Scope-specific built-in variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

ColdFusion tag-specific variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

CGI environment variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Reserved words

The following list indicates words you must not use for ColdFusion variables, user-defined

function names, or custom tag names. While some of these words can be used safely in some

situations, you can prevent errors by avoiding them entirely.

• Any name starting with cf. However, when you call a CFML custom tag directly, you prefix the

custom tag page name with cf_.

• Built-in function names, such as Now or Hash

• Scope names, such as Form or Session

• Operators, such as NE or IS

• The names of any built-in data structures, such as Error or File

• The names of any built-in variables, such as RecordCount or CGI variable names

• CFScript language element names such as for, default, or continue

Remember that ColdFusion is not case-sensitive. For example, all of the following are reserved

words: IS, Is, iS, and is.

8 Chapter 1: Reserved Words and Variables

Reserved words in forms

You must also not create form field names ending in any of the following, except to specify a form

field validation rule using a hidden form field name.

• _integer

• _float

• _range

• _date

• _time

• _eurodate

Reserved words in queries

The following table lists SQL keywords that are reserved in ColdFusion queries of queries. This

list includes all reserved words in the SQL standard, and should be avoided in variables used in all

queries. Do not use these keywords as variable names in any queries.

Note: Many database management systems have additional reserved words that you cannot use as

variable names in queries to their databases. For a detailed list, see your DBMS documentation.

ABSOLUTE ACTION ADD ALL ALLOCATE

ALTER AND ANY ARE AS

ASC ASSERTION AT AUTHORIZATION AVG

BEGIN BETWEEN BIT BIT_LENGTH BOTH

BY CASCADE CASCADED CASE CAST

CATALOG CHAR CHARACTER CHARACTER_

LENGTH

CHAR_LENGTH

CHECK CLOSE COALESCE COLLATE COLLATION

COLUMN COMMIT CONNECT CONNECTION CONSTRAINT

CONSTRAINTS CONTINUE CONVERT CORRESPONDING COUNT

CREATE CROSS CURRENT CURRENT_DATE CURRENT_TIME

CURRENT_

TIMESTAMP

CURRENT_

USER

CURSOR DATE DAY

DEALLOCATE DEC DECIMAL DECLARE DEFAULT

DEFERRABLE DEFERRED DELETE DESC DESCRIBE

DESCRIPTOR DIAGNOSTICS DISCONNECT DISTINCT DOMAIN

DOUBLE DROP ELSE END END-EXEC

ESCAPE EXCEPT EXCEPTION EXEC EXECUTE

EXISTS EXTERNAL EXTRACT FALSE FETCH

FIRST FLOAT FOR FOREIGN FOUND

Scope-specific built-in variables 9

Scope-specific built-in variables

ColdFusion returns variables, such as those returned in a cfdirectory or cfftp operation. A

variable is usually referenced by scoping it according to its type: naming it according to the code

context in which it is available; for example, Session.varname, or Application.varname. For more

information on ColdFusion scopes, see Chapter 3, “Using ColdFusion Variables” in ColdFusion

MX Developer’s Guide

FROM FULL GET GLOBAL GO

GOTO GRANT GROUP HAVING HOUR

IDENTITY IMMEDIATE IN INDICATOR INITIALLY

INNER INPUT INSENSITIVE INSERT INT

INTEGER INTERSECT INTERVAL INTO IS

ISOLATION JOIN KEY LANGUAGE LAST

LEADING LEFT LEVEL LIKE LOCAL

LOWER MATCH MAX MIN MINUTE

MODULE MONTH NAMES NATIONAL NATURAL

NCHAR NEXT NO NOT NULL

NULLIF NUMERIC OCTET_LENGTH OF ON

ONLY OPEN OPTION OR ORDER

OUTER OUTPUT OVERLAPS PAD PARTIAL

POSITION PRECISION PREPARE PRESERVE PRIMARY

PRIOR PRIVILEGES PROCEDURE PUBLIC READ

REAL REFERENCES RELATIVE RESTRICT REVOKE

RIGHT ROLLBACK ROWS SCHEMA SCROLL

SECOND SECTION SELECT SESSION SESSION_USER

SET SIZE SMALLINT SOME SPACE

SQL SQLCODE SQLERROR SQLSTATE SUBSTRING

SUM SYSTEM_USER TABLE TEMPORARY THEN

TIME TIMESTAMP TIMEZONE_

HOUR

TIMEZONE_

MINUTE

TRAILING TRANSACTION TRANSLATE TRANSLATION TRIM

TRUE UNION UNIQUE UNKNOWN UPDATE

UPPER USAGE USER USING VALUE

VALUES VARCHAR VARYING VIEW WHEN

WHENEVER WHERE WITH WORK WRITE

YEAR ZONE

10 Chapter 1: Reserved Words and Variables

You use the cflock tag to limit the scope of CFML constructs that modify shared data structures,

files, and CFXs, to ensure that modifications occur sequentially. For more information, see

cflock on page 270, and Chapter 15, “Using Persistent Data and Locking” in ColdFusion MX

Developer’s Guide.

Variable scope

ColdFusion supports the Variables scope. Unscoped variables created with the

cfset tag acquire

the Variables scope by default. For example, the variable created by the statement

<CFSET

linguist = Chomsky>

can be referenced as #Variables.linguist#

Caller scope

History

ColdFusion MX: The Caller scope is accessible as a structure. (In earlier releases, it was not.)

Client variables

The following client variables are reserved:

Client.CFID

Client.CFToken

Client.HitCount

Client.LastVisit

Client.TimeCreated

Client.URLToken

Server variables

Use the Server prefix to reference server variables, as follows:

Server.ColdFusion.ProductName

Server.ColdFusion.ProductVersion

Server.ColdFusion.ProductLevel

Server.ColdFusion.SerialNumber

Server.ColdFusion.SupportedLocales

Server.ColdFusion.AppServer

Server.ColdFusion.Expiration

Server.ColdFusion.RootDir

Server.OS.Name

Server.OS.AdditionalInformation

Server.OS.Version

Server.OS.BuildNumber

Application and session variables

To enable application and session variables, use the

cfapplication tag or Application.cfc.

Reference them as follows:

Application.myvariable

Session.myvariable

To ensure that modifications to shared data occur in the intended sequence, use the cflock tag.

For more information, see

cflock on page 270.

ColdFusion tag-specific variables 11

The predefined application and session variables are as follows:

Application.ApplicationName

Session.CFID

Session.CFToken

Session.URLToken

Custom tag variables

A ColdFusion custom tag returns the following variables:

ThisTag.ExecutionMode

ThisTag.HasEndTag

ThisTag.GeneratedContent

ThisTag.AssocAttribs[index]

A custom tag can set a Caller variable to provide information to the caller. The Caller variable is

set as follows:

The calling page can access the variable with the cfoutput tag, as follows:

<cfoutput>#variable_name#</cfoutput>

Request variable

Request variables store data about the processing of one page request. Request variables store data

in a structure that can be passed to nested tags, such as custom tags, and processed once.

To provide information to nested tags, set a Request variable, as follows:

...

Each nested tag can access the variable with the cfoutput tag, as follows:

<CFOUTPUT>#Request.field_name1#</CFOUTPUT>

Form variable

ColdFusion supports the Form variable FieldNames. FieldNames returns the names of the fields

on a form. You use it on the action page associated with a form, as follows:

Form.FieldNames

ColdFusion tag-specific variables

Some ColdFusion tags return data as variables. For example, the cffile tag returns file size

information in the FileSize variable, referenced as CFFILE.FileSize.

The following tags return data that can be referenced in variables:

cfcatch

cfdirectory

cferror

12 Chapter 1: Reserved Words and Variables

cffile

cfftp

cfhttp

cfindex

cfldap

cfpop

cfquery

cfregistry

cfsearch

cfstoredproc

ColdFusion query variables

A ColdFusion tag that returns a query object supports the following variables, where queryname is

the value of the

name attribute:

queryname.CurrentRow

queryname.RecordCount

queryname.ColumnList

CFCATCH variables

Within a

cfcatch block, the active exception properties can be accessed as the following

variables:

CFCATCH.Type

CFCATCH.Message

CFCATCH.Detail

CFCATCH.ErrNumber

CFCATCH.NativeErrorCode

CFCATCH.SQLState

CFCATCH.LockName

CFCATCH.LockOperation

CFCATCH.MissingFileName

CFCATCH.TagContext

CFCATCH.ErrorCode

CFCATCH.ExtendedInfo

Within a cfcatch block, database exception properties can be accessed as the following variables:

CFCATCH.QueryError

CFCATCH.SQL

CFCATCH.Where

CFCATCH.Datasource

Within a cfcatch block, undefined variable exception properties can be accessed as the following

variable:

CFCATCH.Name

Within a cfcatch block, syntax and parsing exception properties can be accessed as the following

variables:

CFCATCH.TokenText

CFCATCH.Snippet

CFCATCH.Column

CFCATCH.KnownColumn

ColdFusion tag-specific variables 13

CFCATCH.Line

CFCATCH.KnownLine

CFDIRECTORY variables

The

cfdirectory tag, with action=list, returns a query object as follows, where queryname is

the

name attribute value:

queryname.Name

queryname.Size

queryname.Type

queryname.DateLastModified

queryname.Attributes

queryname.Mode

CFERROR variables

When

cferror generates an error page, the following error variables are available if

type="request" or "exception".

Error.Diagnostics

Error.MailTo

Error.DateTime

Error.Browser

Error.GeneratedContent

Error.RemoteAddress

Error.HTTPReferer

Error.Template

Error.QueryString

The following error variables are available if type="validation".

Error.ValidationHeader

Error.InvalidFields

Error.ValidationFooter

Any cfcatch variable that applies to exception type can be accessed within the Error scope, as

follows:

Error.Type

Error.Message

Error.Detail

Error.ErrNumber

Error.NativeErrorCode

Error.SQLState

Error.LockName

Error.LockOperation

Error.MissingFileName

Error.TagContext

Error.ErrorCode

Error.ExtendedInfo

Note: You can substitute the prefix

CFERROR for Error, if type = "Exception"; for example,

CFERROR.Diagnostics, CFERROR.Mailto, or CFERROR.DateTime.

14 Chapter 1: Reserved Words and Variables

CFFILE ACTION=Upload variables

File variables are read-only. Use the

CFFILE prefix to reference file variables; for example,

CFFILE.ClientDirectory. The File prefix is deprecated in favor of the CFFILE prefix.

CFFILE.AttemptedServerFile

CFFILE.ClientDirectory

CFFILE.ClientFile

CFFILE.ClientFileExt

CFFILE.ClientFileName

CFFILE.ContentSubType

CFFILE.ContentType

CFFILE.DateLastAccessed

CFFILE.FileExisted

CFFILE.FileSize

CFFILE.FileWasAppended

CFFILE.FileWasOverwritten

CFFILE.FileWasRenamed

CFFILE.FileWasSaved

CFFILE.OldFileSize

CFFILE.ServerDirectory

CFFILE.ServerFile

CFFILE.ServerFileExt

CFFILE.ServerFileName

CFFILE.TimeCreated

CFFILE.TimeLastModified

CFFTP error variables

When you use the

cfftp stoponerror attribute, these variables are populated:

CFFTP.Succeeded

CFFTP.ErrorCode

CFFTP.ErrorText

CFFTP ReturnValue variable

Some

cfftp file and directory operations provide a return value, in the variable

CFFTP.ReturnValue. Its value is determined by the results of the

action attribute. When you

specify any of the following actions,

cfftp returns a value:

GetCurrentDir

GetCurrentURL

ExistsDir

ExistsFile

Exists

CFFTP query object columns

When you use the

cfftp tag with the listdir action, cfftp returns a query object, where

queryname is the name attribute value, and row is the row number of each file or directory entry:

queryname.Name[row]

queryname.Path[row]

queryname.URL[row]

queryname.Length[row]

ColdFusion tag-specific variables 15

queryname.LastModified[row]

queryname.Attributes

queryname.IsDirectory

queryname.Mode

CFHTTP variables

cfhttp get operation can return text and binary files. Files are downloaded and the contents

stored in a variable or file, depending on the MIME type, as follows:

CFHTTP.FileContent

CFHTTP.MimeType

CFHTTP.Header

CFHTTP.ResponseHeader

[http_hd_key]

CFHTTP.StatusCode

CFLDAP variables

The

cfldap action=query tag returns information about the LDAP query, as follows:

queryname.CurrentRow

queryname.RecordCount

queryname.ColumnList

CFPOP variables

The

cfpop tag returns the following result columns, depending on the action attribute value and

the use of other attributes, such as

attachmentpath, where queryname is the name attribute value:

queryname.Date

queryname.From

queryname.Body

queryname.Header

queryname.MessageNumber

queryname.ReplyTo

queryname.Subject

queryname.CC

queryname.To

queryname.CurrentRow

queryname.RecordCount

queryname.ColumnList

queryname.Attachments

queryname.AttachmentFiles

CFQUERY and CFSTOREDPROC variables

The

cfquery tag returns information about the query in this variable:

CFQUERY.ExecutionTime

The cfquery tag uses the query name to scope the following data about the query:

queryname.CurrentRow

queryname.RecordCount

queryname.ColumnList

16 Chapter 1: Reserved Words and Variables

The cfstoredproc tag returns the following variables:

CFSTOREDPROC.ExecutionTime

CFSTOREDPROC.StatusCode

CFREGISTRY variables

The

cfregistry tag returns a query record set that you can reference after executing the GetAll

action, as follows, where queryname is the

name attribute value:

queryname.Entry

queryname.Type

queryname.Value

CFSEARCH variables

cfsearch operation returns the following variables, where searchname is the name attribute

value:

searchname.URL

searchname.Key

searchname.Title

searchname.Score

searchname.Custom1 and Custom2

searchname.Summary

searchname.RecordCount

searchname.CurrentRow

searchname.RecordsSearched

searchname.ColumnList

Standard CGI variables

The CGI variables that are available for your use vary with the web server and configuration. This

section lists the CGI 1.1 variables that some web servers create when a CGI script is called. Some

of the following variables may not be available.

Request

CGI.AUTH_TYPE

CGI.CONTENT_LENGTH

CGI.CONTENT_TYPE

CGI.METHOD

CGI.PATH_INFO

CGI.PATH_TRANSLATED

CGI.QUERY_STRING

CGI.REMOTE_ADDR

CGI.REMOTE_HOST

CGI.REMOTE_USER

CGI.REQUEST_METHOD

CGI.SCRIPT_NAME

CGI environment variables 17

Server

CGI.GATEWAY_INTERFACE

CGI.SERVER_NAME

CGI.SERVER_PORT

CGI.SERVER_PROTOCOL

CGI.SERVER_SOFTWARE

Client

CGI.CERT_ISSUER

CGI.CERT_SUBJECT

CGI.CLIENT_CERT_ENCODED

CGI.HTTP_ACCEPT

CGI.HTTP_IF_MODIFIED_SINCE

CGI.HTTP_USER_AGENT

The CERT_ISSUER, CERT_SUBJECT, CLIENT_CERT_ENCODED variables are available only when you

use client certificates.

CGI environment variables

When a browser makes a request to a server, the web server and the browser create environment

variables. In ColdFusion, these variables are referred to as CGI environment variables. They take

the CGI prefix regardless of whether the server uses a server API or CGI to communicate with the

ColdFusion server.

Environment variables contain data about the transaction between the browser and the server,

such as the IP Address, browser type, and authenticated username. You can reference CGI

environment variables for a given page request anywhere in the page. CGI variables are read-only.

Note: The environment variables available to applications depend on the browser and server

software.

Testing for CGI variables

Because some browsers do not support some CGI variables, ColdFusion always returns True

when it tests for the existence of a CGI variable, regardless of whether the browser supports the

variable. To determine if the CGI variable is available, test for an empty string, as shown in the

following example:

CGI variable exists

CGI variable does not exist

</cfif>

18 Chapter 1: Reserved Words and Variables

CGI server variables

The following table describes common CGI environment variables that the server creates (some

of these are not available with some servers):

CGI server variable Description

SERVER_SOFTWARE Name and version of the information server software answering

the request (and running the gateway). Format: name/version.

SERVER_NAME Server's hostname, DNS alias, or IP address as it appears in self-

referencing URLs.

GATEWAY_INTERFACE CGI specification revision with which this server complies. Format:

CGI/revision.

SERVER_PROTOCOL Name and revision of the information protocol this request came in

with. Format: protocol/revision.

SERVER_PORT Port number to which the request was sent.

REQUEST_METHOD Method with which the request was made. For HTTP, this is Get,

Head, Post, and so on.

PATH_INFO Extra path information, as given by the client. Scripts can be

accessed by their virtual pathname, followed by extra information

at the end of this path. The extra information is sent as

PATH_INFO.

PATH_TRANSLATED Translated version of PATH_INFO after any virtual-to-physical

mapping.

SCRIPT_NAME Virtual path to the script that is executing; used for self-referencing

URLs.

QUERY_STRING Query information that follows the ? in the URL that referenced

this script.

REMOTE_HOST Hostname making the request. If the server does not have this

information, it sets REMOTE_ADDR and does not set

REMOTE_HOST.

REMOTE_ADDR IP address of the remote host making the request.

AUTH_TYPE If the server supports user authentication, and the script is

protected, the protocol-specific authentication method used to

validate the user.

REMOTE_USER

AUTH_USER

If the server supports user authentication, and the script is

protected, the username the user has authenticated as. (Also

available as AUTH_USER.)

REMOTE_IDENT If the HTTP server supports RFC 931 identification, this variable is

set to the remote username retrieved from the server. Use this

variable for logging only.

CONTENT_TYPE For queries that have attached information, such as HTTP POST

and PUT, this is the content type of the data.

CONTENT_LENGTH Length of the content as given by the client.

CGI environment variables 19

CGI client variables

The following table describes common CGI environment variables the browser creates and passes

in the request header:

CGI client certificate variables

ColdFusion makes available the following client certificate data. These variables are available

when running Microsoft IIS 4.0 or Netscape Enterprise under SSL if your web server is

configured to accept client certificates.

CGI client variable Description

HTTP_REFERER The referring document that linked to or submitted form data.

HTTP_USER_AGENT The browser that the client is currently using to send the request.

Format: software/version library/version.

HTTP_IF_MODIFIED_SINCE The last time the page was modified. The browser determines

whether to set this variable, usually in response to the server

having sent the LAST_MODIFIED HTTP header.

It can be used to

take advantage of browser-side caching.

CGI client certificate variable Description

CERT_SUBJECT Client-specific information provided by the web server. This data

typically includes the client's name, e-mail address, and so on; for

example:

O = "VeriSign, Inc.", OU = VeriSign Trust Network, OU =

"www.verisign.com/repository/RPA Incorp. by

Ref.,LIAB.LTD(c)98", OU = Persona Not Validated, OU =

Digital ID Class 1 - Microsoft, CN = Matthew Lund, E =

[email protected]

CERT_ISSUER Information about the authority that provided the client certificate;

for example:

O = "VeriSign, Inc.", OU = VeriSign Trust Network, OU =

"www.verisign.com/repository/RPA Incorp. By

Ref.,LIAB.LTD(c)98", CN = VeriSign Class 1 CA Individual

Subscriber-Persona Not Validated

CLIENT_CERT_ENCODED The entire client certificate binary, base-64 encoded. This data is

typically of interest to developers, so they can integrate with other

software that uses client certificates.

20 Chapter 1: Reserved Words and Variables

Page is loading ...

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108

MACROMEDIA COLFUSION MX 7-CFML Reference

Brand: MACROMEDIA

Model: COLFUSION MX 7-CFML

Category: Software

Type: Reference

This manual is also suitable for

COLFUSION MX 7

Download PDF

report

MACROMEDIA COLFUSION MX 7-CFML Reference

This manual is also suitable for

MACROMEDIA COLFUSION MX 7-CFML Reference

Related papers

Other documents