Adobe ColdFusion 8

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"
    name = "query name" 
    sort = "asc|desc"
    type = "string|dWord|key|any">

Note: You can specify this tag's attributes in an attributeCollection attribute whose value is a structure. Specify the structure name in the attributeCollection attribute and use the tag's attribute names as structure keys.

See also

"Using Persistent Data and Locking"7 in the ColdFusion Developer's Guide

Attributes

Attribute

Req/Opt

Default

Description

action

Required

 

Always getall.

branch

Required

 

Name of a registry branch.

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.

type

Optional

string

  • string: returns string values.
  • dWord: returns DWord values.
  • key: returns keys.
  • any: returns keys and values.

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">
<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>