cfregistry action = "getAll"

Description

Returns all registry keys and values defined in a branch. You can access the values as you would any record set.

Syntax

<cfregistry 
  action = "getAll"
  branch = "branch"
  type = "data type"
  name = "query name" 
  sort = "criteria">

Attributes

Attribute Req/Opt Default Description

action
Required

getall

branch
Required

Name of a registry branch.

type
Optional
String

string: return string values

dWord: return DWord values

key: return keys

any: return keys and values

name
Required

Name of record set to contain returned keys and values.

sort
Optional
ASC
Sorts query column data (case-insensitive). Sorts on Entry, Type, and Value columns as text. Specify a combination of columns from query output, in a comma-delimited list. For example:
sort = "value desc, entry asc"

asc: ascending (a to z) sort order

desc: descending (z to a) sort order

Attribute	Req/Opt	Default	Description
action	Required		`getall`
branch	Required		Name of a registry branch.
type	Optional	String	string: return string values dWord: return DWord values key: return keys any: return keys and values
name	Required		Name of record set to contain returned keys and values.
sort	Optional	ASC	Sorts query column data (case-insensitive). Sorts on Entry, Type, and Value columns as text. Specify a combination of columns from query output, in a comma-delimited list. For example: `sort = "value desc, entry asc"` asc: ascending (a to z) sort order desc: descending (z to a) sort order

Usage

This tag returns #entry#, #type#, and #value# in a record set that you can access through tags such as cfoutput. To fully qualify these variables, use the record set name, as specified in the name attribute.

If #type# is a key, #value# is an empty string.

If you specify type= "any", getAll also returns binary registry values. For binary values, the #type# variable contains UNSUPPORTED and #value# is blank.

Example

<!--- This example uses cfregistry with the getAll Action --->
<cfregistry action = "getAll"
  branch = "HKEY_LOCAL_MACHINE\Software\Microsoft\Java VM" 
  type = "Any" name = "RegQuery">
<p><h1>cfregistry action = "getAll"</h1>
<cftable query = "RegQuery" colHeaders HTMLTable border = "Yes">
<cfcol header = "<b>Entry</b>" width = "35" text = "#RegQuery.Entry#">
<cfcol header = "<b>Type</b>" width = "10" text = "#RegQuery.type#">
<cfcol header = "<b>Value</b>" width = "35" text = "#RegQuery.Value#">
</cftable>

Version 6

Comments are no longer accepted for ColdFusion MX. ColdFusion 8 is the current version.

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/coldfusion/6/CFML_Reference/Tags-pt221.htm

CFML Reference