MACROMEDIA COLDFUSION 5 - CFML Reference page 175

Alphabetical List of ColdFusion Tags
Attribute
type
title
key
body
custom1
custom2
URLpath
extensions
query
Description
Optional. Specifies the type of entity being indexed. Default is
CUSTOM. Valid entries are:
file Indexes files.
path Indexes all files in specified path that pass
custom Indexes custom entities from a ColdFusion query.
Required if
type = "Custom"
A title for the collection
A query column name for
The title attribute allows searching collections by title or displaying a
separate title from the actual key.
Optional. A unique identifier reference that specifies one of the
following:
Document filename, if
Fully qualified path, if
A unique identifier, if
that holds the primary key
A query column name for any other
Optional. ASCII text to index or a query column name. Required if
. Ignored for
= "Custom"
. Specifies one of the following:
type = "delete"
The ASCII text to be indexed
A query column name if a query name is specified in
Multiple columns can be specified in a comma-separated list:
body = "employee_name, dept_name, location"
Optional. A custom field you can use to store data during an indexing
operation. Specify a query column name for
Optional. A custom field you can use to store data during an indexing
operation. Usage is the same as for
Optional. Specifies the URL path for files if
. When the collection is searched with
"path"
is automatically be prepended to filenames and returned as the
attribute.
Optional. Specifies the comma-separated list of file extensions that
ColdFusion uses to index files if
CFM, CFML, DBM, DBML.
An entry of "*." returns files with no extension:
extensions = ".htm, .html, .cfm, .cfml, *."
This example returns files with the specified extensions, and files with
no extension.
Optional. Specifies the name of the query against which the collection is
generated.
. Specifies one of the following:
and a valid query name
type
type = "file"
type = "path"
, such as the table column
type = "custom"
argument
type
and
type = "File"
custom1
type = "file"
type = "Path"
filter.
extensions
. Invalid if
type = "Path"
query
and a query name.
type
.
and
type =
, the pathname
cfsearch
url
. Default is HTM, HTML,
157
type