<cfregistry>

edit

Reads, writes, and deletes keys and values in the system registry.

The cfregistry tag is supported on all platforms, including Windows, Linux, Solaris, and HP-UX.

This tag cannot have a body.

This tag is also supported within <cfscript>

<cfregistry action=getAll|get|set|delete branch=string type=string name=string sort=string entry=string variable=string value=string >
Attribute Description
action
string, required 		edit

action to the registry:

  • getAll
  • get
  • set
  • delete
branch
string, required 		edit

Name of a registry branch.

Get All Entries

Retrieve all keys and values from a branch

Attribute Description
type
string, optional 		edit
  • string: return string values
  • dWord: return DWord values
  • key: return keys
  • any: return keys and values
name
string, optional 		edit

Name of record set to contain returned keys and values.
sort
string, optional 		edit

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

Get Single Entry

Retrieve a single registry value

Attribute Description
entry
string, optional 		edit

Registry value to access.
type
string, optional 		edit
  • string: return string values
  • dWord: return DWord values
  • key: return keys
  • any: return keys and values
variable
string, optional 		edit

Variable into which to put value.

Set Registry Value

Create or update a registry entry

Attribute Description
entry
string, optional 		edit

Registry value to access.
type
string, optional 		edit
  • string: return string values
  • dWord: return DWord values
  • key: return keys
  • any: return keys and values
value
string, optional 		edit

Value data to set. If you omit this attribute, cfregistry creates default value, as follows:

  • string: creates an empty string: ""
  • dWord: creates a value of 0 (zero)

Delete Registry Entry

Remove a registry entry

Attribute Description
entry
string, optional 		edit

Registry value to access.

Examples

edit 
<cfregistry action = "getAll"
	branch = "HKEY_LOCAL_MACHINE\Software\Microsoft"
	type = "Any"
	name = "q_registry">
<cfdump var="#q_registry#">

See also