User Guide Cancel

cfregistry

Last updated on May 30, 2024 | Also applies to ColdFusion

CFML Reference User Guide
ColdFusion functions
ColdFusion tags
1. ColdFusion tag summary
2. ColdFusion tags by category
  1. Application framework tags
    1. cfapplication
    2. cfassociate
    3. cferror
    4. cfimport
    5. cfinterface
    6. cflock
    7. cfscript
    8. cfthread
  2. Communications tags
  3. Database manipulation tags
  4. Data output tags
    1. cfchart
    1. cfchartdata
    2. cfchartseries
    3. cfchartset
    4. cfcol
    5. cfcontent
    6. cfdocument
    7. cfdocumentitem
    8. cfdocumentsection
    9. cfflush
    10. cfheader
    11. cflog
    12. cfoutput
    13. cfpresentation
    14. cfpresentationslide
    15. cfpresenter
    16. cfprocessingdirective
    17. cfprint
    18. cfreport
    19. cfreportparam
    20. cfsilent
    21. cftable
  5. Debugging tags
    1. cfdump
    2. cftimer
    3. cftrace
  6. Exception handling tags
    1. cfcatch
    2. cferror
    3. cffinally
    4. cfrethrow
    5. cfthrow
    6. cftry
  7. Extensibility tags
    1. cfchart
    2. cfchartdata
    3. cfchartseries
    4. cfcollection
    5. cfcomponent
    6. cfexecute
    7. cfftp
    8. function
    9. cfindex
    10. cfinterface
    11. cfinvoke
    12. cfinvokeargument
    13. cfobject
    14. cfproperty
    15. cfreport
    16. cfreportparam
    17. cfreturn
    18. cfsearch
    19. cfsharepoint
    20. cfspreadsheet
    21. cfwddx
    22. cfxml
  8. File management tags
    1. cfdirectory
    2. cffile
    3. cffileupload
    4. cfftp
    5. cfzip
    6. cfzipparam
  9. Flow-control tags
    1. cfabort
    2. cfbreak
    3. cfcase
    4. cfcontinue
    5. cfdefaultcase
    6. cfelse
    7. cfelseif
    8. cfexecute
    9. cfexit
    10. cfif
    11. cfinclude
    12. cflocation
    13. cfloop
    14. cfrethrow
    15. cfswitch
    16. cfthrow
    17. cftry
  10. Forms tags
    1. cfapplet
    2. cfcalendar
    3. cffileupload
    4. cfform
    5. cfformgroup
    6. cfformitem
    7. cfgrid
    8. cfgridcolumn
    9. cfgridrow
    10. cfgridupdate
    11. cfinput
    12. cfpdf
    13. cfpdfform
    14. cfpdfformparam
    15. cfpdfparam
    16. cfpdfsubform
    17. cfselect
    18. cfslider
    19. cftextarea
    20. cftree
    21. cftreeitem
  11. Internet Protocol tags
    1. cfajaximport
    2. cfajaxproxy
    3. cfftp
    4. cffeed
    5. cfimap
    6. cfhttp
    7. cfhttpparam
    8. cfldap
    9. cfmail
    10. cfmailparam
    11. cfmailpart
    12. cfpop
    13. cfsprydataset
  12. Page processing tags
    1. cfcache
    2. cfcontent
    3. cfflush
    4. cfheader
    5. cfhtmlhead
    6. cfinclude
    7. cfprocessingdirective
    8. cfsetting
    9. cfsilent
  13. Security tags
  14. Variable manipulation tags
    1. cfcookie
    2. cfdump
    3. cfparam
    4. cfregistry
    5. cfsavecontent
    6. cfschedule
    7. cfset
    8. cfsetting
  15. Other tags
    1. cfimage
    2. cflog
    3. cfregistry
3. Tags a-b
4. Tags c
5. Tags f
6. Tags g-h
  1. cfgraph
  2. cfgraphdata
  3. cfgrid
  4. cfgridcolumn
  5. cfgridrow
  6. cfgridupdate
  7. cfheader
  8. cfhtmlhead
  9. cfhtmltopdf
  10. cfhtmltopdfitem
  11. cfhttp
  12. cfhttpparam
7. Tags i
  1. cfif
  2. cfimage
  3. cfimap
  4. cfimapfilter
  5. cfimpersonate
  6. cfimport
  7. cfinclude
  8. cfindex
  9. cfinput
  10. cfinsert
  11. cfinterface
  12. cfinvoke
  13. cfinvokeargument
8. Tags j-l
9. Tags m-o
10. Tags p-q
  1. cfparam
  2. cfpdf
  3. cfpdfform
  4. cfpdfformparam
  5. cfpdfparam
  6. cfpdfsubform
  7. cfpod
  8. cfpop
  9. cfpresentation
  10. cfpresentationslide
  11. cfpresenter
  12. cfprint
  13. cfprocessingdirective
  14. cfprocparam
  15. cfprocresult
  16. cfprogressbar
  17. cfproperty
  18. cfquery
  19. cfqueryparam
11. Tags r-s
  1. cfregistry
  2. cfreport
  3. cfreportparam
  4. cfrethrow
  5. cfreturn
  6. cfsavecontent
  7. cfschedule
  8. cfscript
  9. cfsearch
  10. cfselect
  11. cfservlet
  12. cfservletparam
  13. cfset
  14. cfsetting
  15. cfsharepoint
  16. cfsilent
  17. cfslider
  18. cfspreadsheet
  19. cfsprydataset
  20. cfstoredproc
  21. cfswitch
12. Tags t
  1. cftable
  2. cftextarea
  3. cftextinput
  4. cfthread
  5. cfthrow
  6. cftimer
  7. cftooltip
  8. cftrace
  9. cftransaction
  10. cftree
  11. cftreeitem
  12. cftry
13. Tags u-z
  1. cfupdate
  2. cfwddx
  3. cfwebsocket
  4. cfwindow
  5. cfxml
  6. cfzip
  7. cfzipparam
CFML Reference
1. Reserved words and variables
2. Ajax JavaScript functions
3. ColdFusion ActionScript functions
4. ColdFusion mobile functions
5. Application.cfc reference
6. Script functions implemented as CFCs
7. ColdFusion Flash Form style reference
8. ColdFusion event gateway reference
9. ColdFusion C++ CFX Reference
10. ColdFusion Java CFX reference
11. WDDX JavaScript Objects
Cloud services

Description

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.

Syntax

The tag syntax depends on the action attribute value. See the following:

cfregistry action = "get"

cfregistry action = "set"

cfregistry action = "getAll"

cfregistry action = "delete"

History

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.

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.

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>

cfregistry action = "get"

Description

Accesses a registry value and stores it in a ColdFusion variable.

Syntax

<cfregistry 
action = "get" 
branch = "branch" 
entry = "key or value" 
variable = "variable" 
type = "string|dWord|key">

Note:

Attributes

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	string: returns string value. dWord: returns DWord value. key: returns key's default value.

Usage

If the value does not exist, the cfregistry tag does not create an entry.

Example

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

Description

Adds a registry key, adds a value, or updates a value.

Syntax

<cfregistry 
action = "set" 
branch = "branch" 
entry = "key or value" 
type = "string|dWord|key" 
value = "data">

Note:

Attributes

Attribute	Req/Opt	Description
action	Required	Always set.
branch	Required	Name of a registry branch.
entry	Required	Key or value to set.
type	Optional	string: sets a string value (default). dWord: sets a DWord value. key: creates a key.
value	Optional	Value data to set. If you omit this attribute, the cfregistry tag creates default value, as follows: string: creates an empty string: "". dWord: creates a value of 0 (zero).

Usage

If it does not exist, the cfregistry tag creates the key or value.

Example

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

Description

Deletes a registry key or value.

Syntax

<cfregistry 
action = "delete" 
branch = "branch" 
entry = "key or value">

Note:

Attributes

Attribute	Req/Opt	Description
action	Required	Always delete.
branch	Required	For key deletion: name of registry key to delete. Do not specify the entry attribute. For value deletion: name of registry branch that contains value to delete. Specify the entry attribute.
entry	Required for value deletion	Value to delete.

Usage

If you delete a key, the cfregistry tag also deletes values and subkeys defined beneath it.

Example

<cfregistry action = "delete" 
branch = "HKEY_LOCAL_MACHINE\Software\cflangref\tempkey" 
entry = "LastCFM01"> 
<h1>cfregistry action = "delete"</h1>

Get help faster and easier

New user?

cfregistry

Description

Category

Syntax

See also

History

cfregistry action = "getAll"

Description

Syntax

See also

Attributes

Usage

Example

cfregistry action = "get"

Description

Syntax

See also

Attributes

Usage

Example

cfregistry action = "set"

Description

Syntax

See also

Attributes

Usage

Example

cfregistry action = "delete"

Description

Syntax

See also

Attributes

Usage

Example

Get help faster and easier

Share this page

Ask the Community

Contact Us