CreateObject: .NET object

Description

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

Returns

A .NET object, that is, a ColdFusion reference to a local or remote .NET assembly class.

Function syntax

CreateObject(type, class, assembly[, server, port, protocol, secure])

See also

cfobject: .NET object, DotNetToCFType, Using Microsoft .NET Assemblies in the Developing ColdFusion Applications

Parameters

Attribute

Default

Description

type

Object type. Must be .NET or dotnet for .NET objects.

class

Name of the .NET class to represent as an object.

assembly

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, specify those assemblies also. 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, specify the absolute path or paths of the local proxy JAR file or files that represent the assemblies.

If you omit this parameter, and there is no local .NET installation, the function fails without generating an error. If you omit this parameter, there is a local .NET installation, and the specified class is not in the .NET core classes, ColdFusion generates an error.

server

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)

Specify this attribute to access .NET components on a remote server.

port

6086

Port number at which the .NET-side agent is listening.

protocol

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

false

Whether to secure communications with the .NET-side agent. If true, ColdFusion uses SSL to communicate with .NET.

Usage

The CreateObject function and cfobject tag differ only in syntax. For more information on creating ColdFusion .NET objects, see cfobject: .NET object. For detailed information on using the .NET assemblies in ColdFusion, see Using Microsoft .NET Assemblies in the Developing ColdFusion Applications.