This tag is deprecated for the UNIX platform. Reads, writes, and deletes keys and values in the system registry. Provides persistent storage of client variables.
Note:
For this tag to execute, it must be enabled in the ColdFusion Administrator. For more information, see Configuring and Administering ColdFusion.
cfregistry action = "get" cfregistry action = "set" cfregistry action = "getAll" cfregistry action = "delete"
cfcookie, cfparam, cfsavecontent, cfschedule, cfset; About resource and sandbox security and Using Persistent Data and Locking in the Developing ColdFusion Applications
ColdFusion MX:
- Deprecated this tag on the UNIX platform. It might not work, and might cause an error, in later releases.
- Changed how persistent data is stored: ColdFusion now stores most persistent data outside the system registry, in XML files.
Returns all registry keys and values defined in a branch. You can access the values as you would any record set.
<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.
Using Persistent Data and Locking in the Developing ColdFusion Applications
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:
|
|
type |
Optional |
string |
|
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.
<!--- 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>
<cfregistry action = "get" branch = "branch" entry = "key or value" variable = "variable" type = "string|dWord|key">
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.
Using Persistent Data and Locking in the Developing ColdFusion Applications
Attribute |
Req/Opt |
Default |
Description |
|---|---|---|---|
action |
Required |
|
Always get. |
branch |
Required |
|
Name of a registry branch. |
entry |
Required |
|
Registry value to access. |
variable |
Required |
|
Variable into which to put value. |
type |
Optional |
string |
|
<!--- This example uses cfregistry with the get action. ---> <cfregistry action = "get" branch = "HKEY_LOCAL_MACHINE\Software\Microsoft\Java VM" entry = "ClassPath" type = "String" variable = "RegValue"> <h1>cfregistry action = "get"</h1> <cfoutput> Java ClassPath value is #RegValue# </cfoutput>
<cfregistry action = "set" branch = "branch" entry = "key or value" type = "string|dWord|key" value = "data">
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.
Using Persistent Data and Locking in the Developing ColdFusion Applications
Attribute |
Req/Opt |
Default |
Description |
|---|---|---|---|
action |
Required |
|
Always set. |
branch |
Required |
|
Name of a registry branch. |
entry |
Required |
|
Key or value to set. |
type |
Optional |
|
|
value |
Optional |
|
Value data to set. If you omit this attribute, the cfregistry tag creates default value, as follows:
|
<!--- This example uses the cfregistry set action to modify registry value data. ---> <!--- Normally you pass in a filename instead of setting one here. ---> <cfset FileName = "dummy.cfm"> <cfregistry action = "set" branch = "HKEY_LOCAL_MACHINE\Software\cflangref" entry = "LastCFM01" type = "String" value = "#FileName#"> <h1>cfregistry action = "set"</h1>
<cfregistry action = "delete" branch = "branch" entry = "key or value">
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.
Using Persistent Data and Locking in the Developing ColdFusion Applications
Attribute |
Req/Opt |
Default |
Description |
|---|---|---|---|
action |
Required |
|
Always delete. |
branch |
Required |
|
|
entry |
Required for value deletion |
|
Value to delete. |
<cfregistry action = "delete" branch = "HKEY_LOCAL_MACHINE\Software\cflangref\tempkey" entry = "LastCFM01"> <h1>cfregistry action = "delete"</h1>
Twitter™ and Facebook posts are not covered under the terms of Creative Commons.