User Guide Cancel

cfobject: .NET object

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

ColdFusion

Open app

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
    2. cfchartdata
    3. cfchartseries
    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
  1. cfcache
  2. cfcalendar
  3. cfcase
  4. cfcatch
  5. cfchart
  6. cfchartdata
  7. cfchartseries
  8. cfclient
  9. cfclientsettings
  10. cfcol
  11. cfcollection
  12. cfcomponent
  13. cfcontent
  14. cfcontinue
  15. cfcookie
  16. Tags d-e
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

Creates a .NET object, that is, a ColdFusion proxy for accessing a class in a local or remote .NET assembly.

Syntax

<cfobject 
class="class name" 
name="instance name" 
type=".NET|dotnet" 
action="create" 
assembly="absolute path" 
port="6086" 
protocol="tcp|http" 
secure="no|yes" 
server = "localhost">

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 NTLM attributes

Note:

The ntlmDomain is required when authType=NTLM.

When a user is part of a domain, the ntlmDomain attribute is mandatory. When a user is not part of a domain, the ntlmDomain attribute is not mandatory.

History

Adobe ColdFusion (2016 release): Added NTLM attributes.

ColdFusion 8: Added .NET and dotnet type values, and the assembly, port, protocol, and secure attributes.

Attributes

Attribute	Req/Opt	Default	Description
class	Required		Name of the .NET class to instantiate as an object.
name	Required		String; reference name of the component to use in your application.
type	Required for .NET		Object type. Must be .NET or dotnet for .NET objects.
action	Optional	create	Action to take. Must be create.
assembly	Optional.	mscorlib.dll which contains the .NET core classes.	For local .NET assemblies, the absolute path or paths to the assembly or assemblies (EXE or DLL files) from which to access the .NET class and its supporting classes. If a class in an assembly requires supporting classes that are in other assemblies, you must also specify those assemblies. You can, however, omit the supporting assemblies for the following types of supporting classes: .NET core classes (classes in mscorlib.dll) Classes in assemblies that are in the global assembly cache (GAC) To specify multiple assemblies, use a comma-delimited list.For remote .NET assemblies, you must specify the absolute path or paths of the local proxy JAR file or files that represent the assemblies. If you omit this attribute, and there is no local .NET installation, the tag fails without generating an error. If you omit this attribute, there is a local .NET installation, and the specified class is not in the .NET core classes, ColdFusion generates an error.
port	Optional	6086	Port number at which the .NET-side agent is listening.
protocol	Optional	tcp	Protocol to use for communication between ColdFusion and .NET. Must be one of the following values: http: Use HTTP/SOAP communication protocol. This option is slower than tcp, but might be required for access through a firewall. tcp: Use binary TCP/IP protocol. This method is more efficient than HTTP.
secure	Optional	false	Whether to secure communications with the .NET-side agent. If true, ColdFusion uses SSL to communicate with .NET.
server	Optional	localhost	Host name or IP address of the server where the .NET-side agent is running. Can be in any of these forms: server name (for example, myserver) IP address (for example, 127.0.0.1) You must specify this attribute to access .NET components on a remote server.

Usage

The cfobject tag with a .NET or dotnet value for the type attribute creates a reference to a .NET object of a given class. Using the reference, you can access the .NET object's fields and methods. The .NET classes do not have to be local, and you can use the cfobject tag on a system that does not have .NET installed, including UNIX-based or OS-X systems.
To access .NET assemblies, do the following:

Install the ColdFusion .NET Extension and run the .NET extension service on the system on which the assemblies are installed. You do not have to install the extension or run the extension service on a ColdFusion system that accesses only remote assemblies. For installation instructions, see Installing and Using ColdFusion.
If the assemblies are located on a remote system, create Java proxies for the .NET classes that you use, copy the proxies to the ColdFusion system, and configure the remote system for access by the proxies. For information on these steps, see Using Microsoft .NET Assemblies in the Developing ColdFusion Applications. If the .NET assemblies are on your ColdFusion system, you do not have to perform these steps.
Accessing methods and fieldsYou call .NET methods as you use any other ColdFusion object methods. In the simplest case, your application code uses the following format to call a .NET class method:

<cfobject type=".NET" name="mathInstance" class="mathClass"> 
assembly="C:/Net/Assemblies/math.dll"> 
<cfset myVar=mathInstance.multiply(1,2)>

If a .NET class has multiple constructors, and you do not want ColdFusion to use the default constructor to create the object, invoke a specific constructor by calling the special init method of the ColdFusion object with the constructor's arguments. For example, you can use the following tags to instantiate com.foo.MyClass(int, int):

<cfobject type=".NET" class="com.foo.MyClass" 
assembly="c:\temp\myLib.dll" name="myObj" > 
<cfset myObj.init(10, 5)>

You access and change .NET class public fields by calling the following methods:

Get_fieldName() 
Set_fieldName()

For example, if the .NET class has a public field named account, you can access and modify its value by using Get_acount() and Set_account() methods, respectively.

You can access, but not modify final fields, so you can only call Get_fieldName() for these fields.

Example

The following example uses the GetProcess method of the .NET System.Diagnostics.Process class to get and display information about the processes running on the local system. Because it uses a core .NET class, for which ColdFusion automatically generates proxies, you do not have to specify an assembly name in the cfobject tag. For more complex examples, including examples that use custom .NET classes, see Using Microsoft .NET Assemblies in the Developing ColdFusion Applications.

<cfobject type=".NET" name="proc" class="System.Diagnostics.Process"> 
<cfset processes = proc.GetProcesses()> 
<cfset arrLen = arrayLen(processes)> 

<table border=0 cellspacing="3" cellpadding="3"> 
<tr bgcolor="#33CCCC"> 
<td style="font-size:12px; font-weight:bold" nowrap>Process ID</td> 
<td style="font-size:12px; font-weight:bold" nowrap>Name</td> 
<td style="font-size:12px; font-weight:bold" nowrap>Memory (KB)</td> 
<td style="font-size:12px; font-weight:bold" nowrap>Peak Memory (KB)</td> 
<td style="font-size:12px; font-weight:bold" nowrap>Virtual Memory Size (KB)</td> 
<td style="font-size:12px; font-weight:bold" nowrap>Start Time</td> 
<td style="font-size:12px; font-weight:bold" nowrap>Total Processor Time</td> 
</tr> 
<cfloop from = 1 to="#arrLen#" index=i> 
<cfset process = processes[i]> 
<cfset id = process.Get_Id()> 
<cfif id neq 0> 
<cfoutput> 
<tr> 
<td align="right">#process.Get_Id()#</td> 
<td>#process.Get_ProcessName()#</td> 
<td align="right">#process.Get_PagedMemorySize()/1000#</td> 
<td align="right">#process.Get_PeakPagedMemorySize()/1000#</td> 
<td align="right">#process.Get_VirtualMemorySize()/1000#</td> 
<td>#process.Get_StartTime()#</td> 
<td>#process.Get_TotalProcessorTime()#</td> 
</tr> 
</cfoutput> 
</cfif> 
</cfloop> 
</table>

Adobe

Get help faster and easier

New user?