cfpop Example
cfpop lets you retrieve and manipulate mail in a POP3 mailbox. This view-only example shows how to create one feature of a mail client, to display the mail headers in a POP3 mailbox.
To execute this, un-comment this code and run with a mail-enabled CF Server. | #GetParks.
cfqueryparam Description Verifies the data type of a query parameter and, for DBMSs that support bind variables, enables ColdFusion to use bind variables in the SQL statement. Bind variable usage enhances performance when executing a cfquery statement multiple times. This tag is nested within a cfquery tag, embedded in a query SQL statement. If you specify optional parameters, this tag performs data validation.
Attributes Attribute Req/Opt value Required Default Description Value that ColdFusion passes to the right of the comparison operator in a where clause. If CFSQLType is a date or time option, ensure that the date value uses your DBMS-specific date format. Use the CreateODBCDateTime or DateFormat and TimeFormat functions to format the date value.
Usage Use the cfqueryparam tag in any SQL statement (for example, SELECT, INSERT, UPDATE, and DELETE) that uses ColdFusion variables. You cannot use the cfquery cachedAfter or cachedWithin attributes with cfqueryparam. For maximum validation of string data, specify the maxlength attribute. This tag does the following: • • • • Allows the use of SQL bind parameters, which improves performance. Ensures that variable data matches the specified SQL type.
ColdFusion JDBC DB2 Informix Oracle MSSQL CF_SQL_CHAR CHAR Char char, nchar char, nchar char, nchar, unique identifier CF_SQL_CLOB CLOB Clob clob clob,nclob CF_SQL_DATE DATE Date date, datetime, year to day CF_SQL_DECIMAL DECIMAL Decimal decimal, money number decimal, money, small money CF_SQL_DISTINCT DISTINCT CF_SQL_DOUBLE DOUBLE Double CF_SQL_FLOAT FLOAT Float float number float CF_SQL_IDSTAMP CHAR Char char, nchar char, nchar char, nchar, unique identifier
ColdFusion JDBC DB2 Informix Oracle CF_SQL_TIMESTAMP TIMESTAMP Timestamp datetime date year to fraction(5) , datetime year to second CF_SQL_TINYINT TINYINT CF_SQL_VARBINARY VARBINARY Rowid CF_SQL_VARCHAR VARCHAR Varchar MSSQL datetime, smalldate time tinyint raw varchar, nvarchar, lvarchar varbinary varchar2, varchar, nvarchar2 nvarchar, sysname Example You Selected the following employees #name#
Email: #email#
SELECT * FROM Messages cfset Example cfset sets and reassigns values to local or global variables within a page. For example, the variable NumRecords has been declared on this page to hold the number of records returned from query (#NumRecords#).
cfsetting Description Controls aspects of page processing, such as the output of HTML code in pages.
Usage The cfsetting requestTimeout attribute replaces the use of requestTimeOut within a URL. To enforce a page timeout, detect the URL variable and use code such as the following to change the page timeout: You can use this tag to manage whitespace in ColdFusion output pages. If you nest cfsetting tags: to make HTML output visible, you must match each enableCFoutputOnly = "Yes" statement with an enableCFoutputOnly = "No" statement.
cfsilent Description Suppresses output produced by CFML within a tag’s scope. Category Data output tags, Page processing tags Syntax ... See also cfcache, cfflush, cfheader, cfhtmlhead, cfinclude, cfsetting; Chapter 9, “Writing and Calling User-Defined Functions,” in ColdFusion MX Developer’s Guide Usage This tag requires an end tag.
cfslider Description Puts a slider control, for selecting a numeric value from a range, in a ColdFusion form. The slider moves over the slider groove. As the user moves the slider, the current value displays. Used within a cfform tag. Not supported with Flash forms.
Attributes Attribute Req/Opt Default Description name Required Name of cfslider control. label Optional Label to display with control; for example, "Volume" This displays: "Volume %value%" To reference the value, use "%value%". If %% is omitted, slider value displays directly after label. range Optional scale Optional value Optional onValidate Optional Custom JavaScript function to validate user input; in this case, a change to the default slider value. Specify only the function name.
Attribute Req/Opt Default Description vertical Optional • Yes: renders slider in browser vertically. You must set width and height attributes; ColdFusion does not automatically swap width and height values. • No: renders slider horizontally. bgColor Optional Background color of slider label. For a hexadecimal value, use the form: bgColor = "##xxxxxx", where x = 0-9 or A-F; use two number signs or none.
If the following conditions are true, a user’s selection from query data that populates this tag’s options continues to display after the user submits the form: • The cfform preserveData attribute is set to "Yes". • The cfform action attribute posts to the same page as the form itself (this is the default), or the action page has a form that contains controls with the same names as corresponding controls on the user entry form. For more information, see the cfform tag entry.
cfstoredproc Description Executes a stored procedure in a server database. It specifies database connection information and identifies the stored procedure.
Attribute Req/Opt Default Description returnCode Optional No result Optional • Yes: populates cfstoredproc.statusCode with status code returned by the stored procedure. • No Specifies a name for the structure in which cfstoredproc returns the statusCode and ExecutionTime variables. If set, this value replaces cfstoredproc as the prefix to use when accessing those variables. For more information, see the Usage section. Usage Use this tag to call a database stored procedure.
---> SELECT Emp_ID, FirstName, LastName, EMail, Phone, Department FROM Employees cfswitch Example You've Thrown an Error #cfcatch.message# The contents of the tag stack are:
cftimer Description Displays execution time for a specified section of CFML code. ColdFusion MX displays the timing information along with any output produced by the timed code. Note: To permit this tag to execute, you must enable the Timer Information option under Debugging Settings in the ColdFusion MX Administrator.
Example1 ...
from Departments Scroll down to CFTimer Times heading to see timing information ...
cftrace Description Displays and logs debugging data about the state of an application at the time the cftrace tag executes. Tracks runtime logic flow, variable values, and execution time. Displays output at the end of the request or in the debugging section at the end of the request; or, in Dreamweaver MX and later, in the Server Debug tab of the Results window. ColdFusion logs cftrace output to the file logs\cftrace.log, in the ColdFusion installation directory.
Attribute Req/Opt Default Description type Optional Corresponds to the cflog type attribute; displays an appropriate icon: • Information • Warning • Error • Fatal Information var Optional Information The name of a simple or complex variable to display. Useful for displaying a temporary value, or a value that does not display on any CFM page. Usage You cannot put application code within this tag. (This avoids problems that can occur if you disable debugging.
cftransaction Description For enterprise database management systems that support transaction processing, instructs the database management system to treat multiple database operations as a single transaction. Provides database commit and rollback processing. See the documentation for your database management system to determine whether it supports SQL transaction processing.
Usage If you do not specify a value for the action attribute, automatic transaction processing proceeds as follows: • If the cfquery operations within the transaction block complete without an error, the transaction is committed. • If a cfquery tag generates an error within a cftransaction block, all cfquery operations in the transaction roll back. If you do not specify a value for the isolation attribute, ColdFusion uses the default isolation level for the associated database.
cftree Description Inserts a tree control in a form. Validates user selections. Used within a cfform tag block. You can use a ColdFusion query to supply data to the tree.
History ColdFusion MX 7: • Added the format attribute and support for generating Flash and XML and object output. • Added enabled, onChange, style, tooltip, and visible attributes (Flash format only). ColdFusion MX: Changed behavior: ColdFusion renders a tree control regardless of whether there are any treeitems within it. Attributes Note: In XML format, ColdFusion MX passes all attributes to the XML.
Attribute Req/Opt Default Format Description appendKey Optional; Yes All • Yes: if you use cftreeitem href attributes, ColdFusion appends a CFTREEITEMKEY query string variable with the value of the selected tree item to the cfform action URL. • No: does not append the tree item value to the URL. highlightHref Optional; Yes Applet, Object • Yes: highlights as a link the displayed value for any cftreeitem tag that specifies an href attribute. • No: disables highlighting.
Attribute Req/Opt Default Format Description align Optional; Applet, object • • • • • • • • • border Optional; Yes Applet, object • Yes: displays a border around the tree control. • No hScroll Optional; Yes Applet, object • Yes: permits horizontal scrolling. • No vScroll Optional; Yes Applet, object • Yes: permits vertical scrolling.
Note: All attributes are passed to the XML generated in XML format, but no ColdFusion MX skin interprets cftree XML. Usage This tag must be in a cfform tag block. The applet format tree requires the client to download a Java applet. Also, if the client does not have an up-to-date Java plugin installed, the system might also have to download an updated Java plugin to display an applet format tree. The Flash format tree uses a Flash control, and can be embedded in an HTML format cfform tag.
The structure variable name is specified by the cftree name attribute. The top level of the structure has two types of entries: • Attribute settings • A children array Attribute settings The structure has top-level entries with the values of the following cftree attributes: align completePath highlightHref lookAndFeel appendKey delimiter hScroll name bold fontWeight italic vscroll border Children array The top-level children entry is an array of items entries.
from CourseList c, Departments d where d.Dept_ID = c.Dept_ID order by d.dept_Name, c.corName, c.
You Requested information on #URL.cftreeitemKey#; User ID #URL.user_ID#
Serializing CFML data... Resulting WDDX packet is: <![CDATA[<cfoutput>#wddxText#</cfoutput>]]> Deserializing WDDX packet... The recordset data is:...
cfxml Description Creates a ColdFusion XML document object that contains the markup in the tag body. This tag can include XML and CFML tags. ColdFusion processes the CFML code in the tag body, and then assigns the resulting text to an XML document object variable, which is always stored in Unicode.
To change the declaration to specify another encoding, use the Replace function. To specify the encoding of the text that is returned to a browser or other application, use the cfcontent tag.
CHAPTER 3 ColdFusion Functions This chapter lists and categorizes ColdFusion Markup Language (CFML) functions. Contents Function list. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449 Functions by category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452 Function changes since ColdFusion 5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ArrayPrepend GetSOAPResponseHeader QueryAddRow ArrayResize GetTempDirectory QueryNew ArraySet GetTempFile QuerySetCell ArraySort GetTickCount QuotedValueList ArraySum GetTimeZoneInfo Rand ArraySwap GetToken Randomize ArrayToList Hash RandRange Asc Hour REFind ASin HTMLCodeFormat REFindNoCase Atn HTMLEditFormat ReleaseComObject BinaryDecode IIf RemoveChars BinaryEncode IncrementValue RepeatString BitAnd InputBaseN Replace BitMaskClear Insert ReplaceList BitMaskR
CreateTimeSpan IsXmlElem StructCopy CreateUUID IsXmlNode StructCount DateAdd IsXmlRoot StructDelete DateCompare JavaCast StructFind DateConvert JSStringFormat StructFindKey DateDiff LCase StructFindValue DateFormat Left StructGet DatePart Len StructInsert Day ListAppend StructIsEmpty DayOfWeek ListChangeDelims StructKeyArray DayOfWeekAsString ListContains StructKeyExists DayOfYear ListContainsNoCase StructKeyList DaysInMonth ListDeleteAt StructNew DaysInYear ListFind
GetBaseTagList LSIsNumeric XmlParse GetBaseTemplatePath LSNumberFormat XmlSearch GetClientVariablesList LSParseCurrency XmlTransform GetCurrentTemplatePath LSParseDateTime XmlValidate GetDirectoryFromPath LSParseEuroCurrency Year GetEncoding LSParseNumber YesNoFormat GetException LSTimeFormat GetFileFromPath LTrim Functions by category The following tables list functions by their category or purpose. Array functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ArrayDeleteAt ArrayMin ArraySort ListToArray ArrayInsertAt ArrayNew ArraySum ArrayToList Hash ToScript BinaryDecode LCase ToString XmlParse BinaryEncode ListToArray URLDecode XmlTransform CharsetDecode ToBase64 URLEncodedFormat CharsetEncode ToBinary Val Conversion functions XmlFormat Date and time functions CreateDate DateFormat GetTimeZoneInfo MonthAsString CreateDateTime DatePart Hour Now CreateODBCDate Day IsDate ParseDateTime CreateODBCDateTime DayOfWeek IsLeapYea
Display and formatting functions CJustify HTMLCodeFormat LSIsDate NumberFormat DateFormat HTMLEditFormat LSNumberFormat ParagraphFormat DecimalFormat LJustify LSParseCurrency RJustify DollarFormat LSCurrencyFormat LSParseDateTime StripCR FormatBaseN LSDateFormat LSParseEuroCurrency TimeFormat GetLocale LSEuroCurrencyFormat LSParseNumber GetLocaleDisplayName LSIsCurrency YesNoFormat LSTimeFormat Dynamic evaluation functions DE Evaluate IIf SetVariable Extensibility functions Creat
Compare Left ListGetAt ListValueCount CompareNoCase Len ListInsertAt ListValueCountNoCase Decrypt ListAppend ListLast ReplaceList Encrypt ListChangeDelims ListLen Find ListContains ListPrepend Mathematical functions Abs BitNot FormatBaseN Randomize ACos BitOr IncrementValue RandRange ArrayAvg BitSHLN InputBaseN Round ArraySum BitSHRN Int Sgn ASin BitXor Log Sin Atn Ceiling Log10 Sqr BitAnd Cos Max Tan BitMaskClear DecrementValue Min BitMaskRead Exp Pi BitM
String-processing functions process any of these characters (including ASCII 0 (NUL) characters), and continue counting subsequent characters of the string, if any. (In earlier releases, some string-processing functions processed the ASCII 0 (NUL) character, but did not process subsequent characters of the string.
GetContextRoot GetMetaData SetLocale GetCurrentTemplatePath GetMetricData SetProfileString GetDirectoryFromPath GetPageContext WriteOutput GetEncoding GetProfileSections GetException GetProfileString XML functions AddSOAPRequestHeader IsSOAPRequest IsXmlRoot XmlGetNodeType AddSOAPResponseHeader IsXML IsWDDX XmlNew GetSOAPRequest IsXmlAttribute ToString XmlParse GetSOAPRequestHeader IsXmlDoc XmlChildPos XmlSearch GetSOAPResponse IsXmlElem XmlElemNew XmlTransform XmlFormat Xml
Function Parameter or value Added in this ColdFusion release GetAuthUser All ColdFusion MX GetContextRoot All ColdFusion MX 7 GetEncoding All ColdFusion MX GetLocaleDisplayName 458 ColdFusion MX 7 GetMetaData All ColdFusion MX GetPageContext All ColdFusion MX GetProfileSections All ColdFusion MX GetSOAPRequest All ColdFusion MX 7 GetSOAPRequestHeader All ColdFusion MX 7 GetSOAPResponse All ColdFusion MX 7 GetSOAPResponseHeader All ColdFusion MX 7 Hash algorithm and encod
Function Parameter or value Added in this ColdFusion release ToScript All ColdFusion MX 7 URLDecode charset parameter ColdFusion MX URLEncodedFormat charset parameter ColdFusion MX URLSessionFormat All ColdFusion MX Wrap All ColdFusion MX 6.
Obsolete functions, parameters, and values The following functions, parameters, and values are obsolete. Do not use them in ColdFusion applications. They do not work in releases later than ColdFusion 5.
CHAPTER 3 ColdFusion Functions Abs Description Absolute-value function. The absolute value of a number is the number without its sign. Returns The absolute value of a number. Category Mathematical functions Function syntax Abs(number) See also Sgn Parameters Parameter Description number A number Example Abs Example The absolute value of the following numbers: 1,3,-4,-3.2,6 is #Abs(1)#,#Abs(3)#,#Abs(-4)#,#Abs(-3.
ACos Description Arccosine function. The arccosine is the angle whose cosine is number. Returns The arccosine, in radians, of a number. Category Mathematical functions Function syntax ACos(number) See also Cos, Sin, ASin, Tan, Atn, Pi Parameters Parameter Description number Cosine of an angle. The value must be between -1.0 and 1.0, inclusive. Usage The range of the result is 0 to π. To convert degrees to radians, multiply degrees by π/180. To convert radians to degrees, multiply radians by 180/π.
AddSOAPRequestHeader Description Adds a SOAP header to a web service request before making the request. Returns Nothing. Category XML functions History ColdFusion MX 7: Added this function.
AddSOAPRequestHeader Example // Create the web service object. ws = CreateObject("webservice", "http://localhost/soapheaders/ headerservice.cfc?WSDL"); // Set the username header as a string.
AddSOAPResponseHeader Description Adds a SOAP response header to a web service response. Call only from within a CFC web service function that is processing a request as a SOAP web service. Returns Nothing Category XML functions History ColdFusion MX 7: Added this function.
Save the following code as headerservice.cfc in a folder called soapheaders under your web root. Test its operation, and specifically the operation of the AddSOAPResponseHeader function, by executing the examples that invoke this web service. For example, see the example for AddSOAPRequestHeader. AddSOAPResponseHeader Example This is what the array looks like after delete:
#DaysArray[1][1]# #DaysArray[1][2]#
#DaysArray[2][1]# #DaysArray[2][2]#
ArrayInsertAt Description Inserts a value into an array. Array elements whose indexes are equal to or greater than the new position are incremented by one. The array length increases by one. Returns True, on successful completion.
Add an element before position 3: #ArrayInsertAt(DaysArray,3,"Wednesday")# Now output the array as a list: #ArrayToList(DaysArray)# Enter the sine of the angle to calculate, in degrees and radians. The value must be between 1 and -1,inclusive.
Atn Description Arctangent function. The arctangent is the angle whose tangent is number. Returns The arctangent, in radians, of a number. Category Mathematical functions Function syntax Atn(number) See also Atn, Sin, ASin, Cos, ACos, Pi Parameters Parameter Description number Tangent of an angle Usage The range of the result is -π/2 to π/2 radians. To convert degrees to radians, multiply degrees by π/180. To convert radians to degrees, multiply radians by 180/π.
AuthenticatedContext Description This function is obsolete. Use the newer security tools; see “Conversion functions” on page 453 and Chapter 16, “Securing Applications” in ColdFusion MX Developer’s Guide. History ColdFusion MX: This function is obsolete. It does not work in ColdFusion MX and later ColdFusion releases.
AuthenticatedUser Description This function is obsolete. Use the newer security tools; see “Conversion functions” on page 453 and Chapter 16, “Securing Applications” in ColdFusion MX Developer’s Guide. History ColdFusion MX: This function is obsolete. It does not work in ColdFusion MX and later ColdFusion releases.
BinaryDecode Description Converts a string to a binary object. Used to convert binary data that has been encoded into string format back into binary data. Returns A binary object. Category Conversion functions, String functions Function syntax BinaryDecode(string, binaryencoding) See also BinaryEncode, CharsetEncode, CharsetDecode History ColdFusion MX 7: Added this function. Parameters Parameter Description string A string containing encoded binary data.
Example The following example reads a GIF file as binary data, converts it to a binary-encoded string, converts the binary-encoded data back to binary data and writes the result to a file. It displays the encoded string and the image in the output file. Binary Encoding Conversion Example
BitAnd Description Performs a bitwise logical AND operation. Returns The bitwise AND of two long integers. Category Mathematical functions Function syntax BitAnd(number1, number2) See also BitNot, BitOr, BitXor Parameters Parameter Description number1 32-bit signed integer number2 32-bit signed integer Usage Bit functions operate on 32-bit signed integers, in the range -2147483648 – 2147483647. Example BitAnd Example Returns the bitwise AND of two long integers.
BitMaskClear Description Performs a bitwise mask clear operation. Returns A number, bitwise cleared, with length bits beginning at start.
BitMaskRead Description Performs a bitwise mask read operation. Returns An integer, created from length bits of number, beginning at start.
BitMaskSet Description Performs a bitwise mask set operation. Returns A number, bitwise masked with length bits of mask beginning at start.
BitNot Description Performs a bitwise logical NOT operation. Returns A number; the bitwise NOT of a long integer. Category Mathematical functions Function syntax BitNot(number) See also BitAnd, BitOr, BitXor Parameters Parameter Description number 32-bit signed integer Usage Bit functions operate on 32-bit signed integers, in the range -2147483648 – 2147483647. Example BitNot Example Returns the bitwise NOT of a long integer.
BitOr Description Performs a bitwise logical OR operation. Returns A number; the bitwise OR of two long integers. Category Mathematical functions Function syntax BitOr(number1, number2) See also BitAnd, BitNot, BitXor Parameters Parameter Description number1 32-bit signed integer number2 32-bit signed integer Usage Bit functions operate on 32-bit signed integers, in the range -2147483648 – 2147483647. Example BitOr Example Returns the bitwise OR of two long integers.
BitSHLN Description Performs a bitwise shift-left, no-rotation operation. Returns A number, bitwise shifted without rotation to the left by count bits. Category Mathematical functions Function syntax BitSHLN(number, count) See also BitSHRN Parameters Parameter Description number 32-bit signed integer count Integer, in the range 0-31, inclusive; number of bits to shift the number Usage Bit functions operate on 32-bit signed integers, in the range -2147483648 – 2147483647.
BitSHRN Description Performs a bitwise shift-right, no-rotation operation. Returns A number, bitwise shifted, without rotation, to the right by count bits. Category Mathematical functions Function syntax BitSHRN(number, count) See also BitSHLN Parameters Parameter Description number 32-bit signed integer count Integer, in the range 0-31, inclusive. Number of bits to shift the number Usage Bit functions operate on 32-bit signed integers, in the range -2147483648 – 2147483647.
BitXor Description Performs a bitwise logical XOR operation. Returns Bitwise XOR of two long integers. Category Mathematical functions Function syntax BitXor(number1, number2) See also BitAnd, BitNot, BitOr Parameters Parameter Description number1 32-bit signed integer number2 32-bit signed integer Usage Bit functions operate on 32-bit signed integers, in the range -2147483648 – 2147483647. Example BitXOr Example Returns the bitwise XOR of two long integers.
Ceiling Description Determines the closest integer that is greater than a specified number. Returns The closest integer that is greater than a given number. Category Mathematical functions Function syntax Ceiling(number) See also Int, Fix, Round Parameters Parameter Description number A real number Example Ceiling Example The ceiling The ceiling The ceiling The ceiling of of of of 3.4 is #ceiling(3.4)# 3 is #ceiling(3)# 3.8 is #ceiling(3.8)# -4.
CharsetDecode Description Converts a string to a binary representation. Returns A binary object that represents the string. Category Conversion functions, String functions Function syntax CharsetDecode(string, encoding) See also BinaryDecode, BinaryEncode, CharsetEncode; “Determining the page encoding of server output” in Chapter 17, “Developing Globalized Applications,” in ColdFusion MX Developer’s Guide History ColdFusion MX 7: Added this function.
Example The following example uses the CharsetDecode function to convert a string from a form to a binary object, and uses the CharsetEncode function to convert it back to the original value. You can change the character encoding that ColdFusion uses for the conversion. Notice that if you select the Asian language encodings, characters that are not in the specified character set do get successfully converted.
510 Chapter 3: ColdFusion Functions
CharsetEncode Description Uses the specified encoding to convert binary data to a string. Returns A string representation of the binary object. Category Conversion functions, String functions Function syntax CharsetEncode(binaryobject, encoding) See also BinaryDecode, BinaryEncode, CharsetDecode; “Determining the page encoding of server output” in Chapter 17, “Developing Globalized Applications,” in ColdFusion MX Developer’s Guide History ColdFusion MX 7: Added this function.
Example The following example uses the CharsetDecode function to convert a string from a form to a binary object, and uses the CharsetEncode function to convert it back to the original value. You can change the character encoding that ColdFusion uses for the conversion. Notice that if you select the Asian language encodings, characters that are not in the specified character set do get successfully converted.
CharsetEncode 513
Chr Converts a numeric value to a UCS-2 character. Returns A character with the specified UCS-2 character code. Category String functions Function syntax Chr(number) See also Asc History ColdFusion MX: Changed Unicode support: ColdFusion supports the Java UCS-2 representation of Unicode characters, up to a value of 65535. (Earlier releases supported 1-255.
maxlength="5" > Chr 515
CJustify Description Centers a string in a field length. Returns String, center-justified by adding spaces before or after the input parameter. If length is less than the length of the input parameter string, the string is returned unchanged. Category Display and formatting functions, String functions Function syntax Cjustify(string, length) See also LJustify, RJustify Parameters Parameter Description string A string or a variable that contains one. May be empty.
Compare Description Performs a case-sensitive comparison of two strings. Returns • -1, if string1 is less than string2 • 0, if string1 is equal to string2 • 1, if string1 is greater than string2 Category String functions Function syntax Compare(string1, string2) See also CompareNoCase, Find Parameters Parameter Description string1 A string or a variable that contains one string2 A string or a variable that contains one Usage Compares the values of corresponding characters in string1 and string2.
This is the default case
Formatted with CreateDate and DateFormat: #DateFormat(CreateDate(form.year, form.month, form.day), "mmm-ddyyyy")# Formatted with CreateDateTime and DateFormat: #DateFormat(CreateDateTime(form.year, form.month, form.day, 12,13,0))# Formatted with CreateODBCDate and DateFormat: #DateFormat(CreateODBCDate(yourDate), "mmmm d, yyyy")# Formatted with CreateODBCDateTime and DateFormat: #DateFormat(CreateODBCDateTime(yourDate), "d/m/yy")# PAGE 525
CreateDateTime Description Creates a date-time object. Returns A date/time value. Category Date and time functions Function syntax CreateDateTime(year, month, day, hour, minute, second) See also CreateDate, CreateTime, CreateODBCDateTime, Now; “Date-time functions and queries when ODBC is not supported” in Chapter 3, “Using ColdFusion Variables,” in ColdFusion MX Developer’s Guide Parameters Parameter Description year Integer in the range 0-9999. Integers in the range 0-29 are converted to 20002029.
The same value can be formatted with DateFormat: - Formatted with CreateDate and DateFormat: #DateFormat(CreateDate(form.year, form.month, form.day), "mmm-dd-yyyy")#
- Formatted with CreateDateTime and DateFormat: #DateFormat(CreateDateTime(form.year, form.month, form.day, form.hour, form.minute, form.
-
CreateObject Description Creates a ColdFusion object, of a specified type. Returns An object, of the specified type. Note: You can enable and disable this function in the ColdFusion Administrator, ColdFusion Basic Security, Tag Restrictions page. Category Extensibility functions History ColdFusion MX 7: For web service object: added the portName parameter, which specifies a port named in the service element of the WSDL.
-
CreateObject: COM object Description The CreateObject function can create a Component Object Model (COM) object. To create a COM object, you must provide this information: • The object’s program ID or filename • The methods and properties available to the object through the IDispatch interface • The arguments and return types of the object's methods For most objects, you can get this information from the OLEView utility. Note: On UNIX, this function does not support COM objects. Returns A COM object.
-
Usage The following example creates the Windows Collaborative Data Objects (CDO) for NTS NewMail object to send mail. You would use this code within a cfscript tag. Mailer = CreateObject("COM", "CDONTS.
-
CreateObject: component object Description The CreateObject function can create an instance of a ColdFusion component (CFC) object. Returns A component object. Function syntax CreateObject(type, component-name) See also Chapter 10, “Building and Using ColdFusion Components” in ColdFusion MX Developer’s Guide Parameters Parameter Description type Type of object to create.
-
CreateObject: CORBA object Description The CreateObject function can call a method on a CORBA object. The object must be defined and registered for use. Returns A handle to a CORBA interface. Function syntax CreateObject(type, context, class, locale) See also Chapter 38, “Integrating COM and CORBA Objects in CFML Applications” in ColdFusion MX Developer’s Guide History See the History section of the main CreateObject function page. Parameters Parameter Description type Type of object to create.
-
ColdFusion Enterprise supports CORBA through the Dynamic Invocation Interface (DII). To use this function with CORBA objects, you must provide the name of the file that contains a string version of the IOR, or the object’s naming context in the naming service. You must provide the object’s attributes, method names and method signatures. This function supports user-defined types (structures, arrays, and sequences). Example myobj = CreateObject("corba", "d:\temp\tester.
-
CreateObject: Java or EJB object Description The CreateObject function can create a Java object, and, by extension, an EJB object. Returns A Java object. Function syntax CreateObject(type, class) Parameters Parameter Description type Type of object to create. • com • corba • java • component • webservice class A Java class name Usage Any Java class available in the class path that is specified in the ColdFusion Administrator can be loaded and used from ColdFusion with the CreateObject function.
-
CreateObject: web service object Description This function can create a web service object. Returns A web service object. Function syntax CreateObject(type, urltowsdl [, portname ]) Parameters Parameter Description type Type of object to create. • com • corba • java • component • webservice urltowsdl WSDL file URL; location of web service portname The port name for the web service. This value is case-sensitive and corresponds to the port element’s name attribute under the service element.
-
CreateODBCDate Description Creates an ODBC date object. Returns A date object, in normalized ODBC date format. Category Date and time functions Function syntax CreateODBCDate(date) See also CreateDate, CreateODBCDateTime Parameters Parameter Description date Date or date/time object in the range 100 AD–9999 AD. Usage This function does not parse or validate values.
-
#DateFormat(CreateDateTime(form.year, form.month, form.day, form.hour, form.minute, form.second))# - Formatted with CreateODBCDate and DateFormat: #DateFormat(CreateODBCDate(yourDate), "mmmm d, yyyy")#
- Formatted with CreateODBCDateTime and DateFormat: #DateFormat(CreateODBCDateTime(yourDate), "d/m/yy")#
PAGE 537
CreateODBCDateTime Description Creates an ODBC date-time object. Returns A date-time object, in ODBC timestamp format. Category Date and time functions Function syntax CreateODBCDateTime(date) See also CreateDateTime, CreateODBCDate, CreateODBCTime, Now; “Evaluation and type conversion issues” in Chapter 3, “Using ColdFusion Variables,” in ColdFusion MX Developer’s Guide Parameters Parameter Description date Date-time object in the range 100 AD–9999 AD.
Formatted with CreateODBCDate and DateFormat: #DateFormat(CreateODBCDate(yourDate), "mmmm d, yyyy")# Formatted with CreateODBCDateTime and DateFormat: #DateFormat(CreateODBCDateTime(yourDate), "d/m/yy")# PAGE 539
CreateODBCTime Description Creates an ODBC time object. Returns A time object, in ODBC timestamp format. Category Date and time functions Function syntax CreateODBCTime(date) See also CreateODBCDateTime, CreateTime, “Evaluation and type conversion issues” in Chapter 3, “Using ColdFusion Variables,” in ColdFusion MX Developer’s Guide Parameters Parameter Description date Date/time object in the range 100 AD–9999 AD.
CreateTime Description Creates a time variable. Returns A time variable. Category Date and time functions Function syntax CreateTime(hour, minute, second) See also CreateODBCTime, CreateDateTime; “Evaluation and type conversion issues” in Chapter 3, “Using ColdFusion Variables,” in ColdFusion MX Developer’s Guide Parameters Parameter Description hour Number in the range 0–23 minute Number in the range 0–59 second Number in the range 0–59 Usage CreateTime is a subset of CreateDateTime.
MESSAGE="You must enter a value for seconds (0-59)" VALIDATE="integer" REQUIRED="Yes"> CreateTime 541
CreateTimeSpan Description Creates a date/time object that defines a time period. You can add or subtract it from other datetime objects and use it with the cachedWithin attribute of cfquery. Returns A date-time object.
cachedWithin = "#CreateTimeSpan(0, 6, 0, 0)#"> SELECT PARKNAME, REGION, STATE FROM Parks ORDER by ParkName, State | Park Name | Region | State | SELECT UserName, Subject, Posted FROM Messages This example uses DateAdd to determine when a message in the database will expire.
DateCompare Description Performs a full date/time comparison of two dates. Returns • -1, if date1 is earlier than date2 • 0, if date1 is equal to date2 • 1, if date1 is later than date2 Category Date and time functions Function syntax DateCompare("date1", "date2" [, "datePart"]) See also CreateDateTime, DatePart Parameters Parameter Description date1 Date/time object, in the range 100 AD–9999 AD. date2 Date/time object, in the range 100 AD–9999 AD. datePart Optional. String.
#TimeFormat(FORM.date2)# (Date The dates are not equal #DateFormat(FORM.date1)# #TimeFormat(FORM.date1)# (Date to #DateFormat(FORM.date2)# #TimeFormat(FORM.date2)# (Date The dates are equal! #DateFormat(FORM.date1)# #TimeFormat(FORM.date1)# (Date than #DateFormat(FORM.date2)# #TimeFormat(FORM.
550 Chapter 3: ColdFusion Functions
DateConvert Description Converts local time to Coordinated Universal Time (UTC), or UTC to local time. The function uses the daylight savings settings in the executing computer to compute daylight savings time, if required. Returns UTC- or local-formatted time object. Category Date and time functions Function syntax DateConvert("conversion-type", "date") See also GetTimeZoneInfo, CreateDateTime, DatePart Parameters Parameter Description conversion-type • local2Utc: Converts local time to UTC time.
Your date and time value, converted to Coordinated Universal Time (UTC): #yourUTC#. Your UTC date and time, converted back to local date and time: #DateConvert("utc2local", yourUTC)#. Type the date and time, and press Enter to see the conversion.
Enclose string constant dates in quotation marks. If the text contains only numbers (such 1932), and is not surrounded by quotation marks, ColdFusion interprets it as a date/time object, resulting in an incorrect value. Example
Please enter two valid date/time values, formatted like this: #DateFormat(Now())#
Usage When passing a date/time object as a string, you must enclose it in quotation marks. Otherwise, it is interpreted as a numeric representation of a date/time object. Note: You can pass the CreateDate function or Now function as the date parameter of this function; for example: #DateFormat(CreateDate(2001, 3, 3))# Date and time values in database query results can vary in sequence and formatting unless you use functions to format them.
DatePart Description Extracts a part from a date value. Returns Part of a date, as an integer. Category Date and time functions Function syntax DatePart("datepart", "date") See also DateAdd, DateConvert History ColdFusion MX 6.1: Added the datepart character L or l to represent milliseconds.
- year: #DatePart("yyyy", todayDate)#
- quarter: #DatePart("q", todayDate)#
- month: #DatePart("m", todayDate)#
- day of year: #DatePart("y", todayDate)#
- day: #DatePart("d", todayDate)#
- weekday: #DatePart("w", todayDate)#
- week: #DatePart("ww", todayDate)#
- hour: #DatePart("h", todayDate)#
- minute: #DatePart("n", todayDate)#
- second: #DatePart("s", todayDate)#
DatePart 559
Day Description Determines the day of the month, in a date. Returns The ordinal for the day of the month, ranging from 1 to 31. Category Date and time functions Function syntax Day("date") See also DayOfWeek, DayOfWeekAsString, DayOfYear, DaysInMonth, DaysInYear, FirstDayOfMonth Parameters Parameter Description date Date/time object, in the range 100 AD–9999 AD. Usage When passing a date/time object as a string, you must enclose it in quotation marks.
DayOfWeek Description Determines the day of the week, in a date. Returns The ordinal for the day of the week, as an integer in the range 1 (Sunday) to 7 (Saturday). Category Date and time functions Function syntax DayOfWeek("date") See also Day, DayOfWeekAsString, DayOfYear, DaysInMonth, DaysInYear, FirstDayOfMonth Parameters Parameter Description date Date/time object, in the range 100 AD–9999 AD. Usage When passing a date/time object as a string, you must enclose it in quotation marks.
DayOfWeekAsString Description Determines the day of the week, in a date, as a string function. Returns The day of the week, as a string in the current locale, that corresponds to day_of_week. Category Date and time functions, String functions Function syntax DayOfWeekAsString(day_of_week) See also Day, DayOfWeek, DayOfYear, DaysInMonth, DaysInYear, FirstDayOfMonth History ColdFusion MX 7: Changed behavior. The returned string is now in the language of the current locale.
DayOfYear Description Determines the day of the year, in a date. Returns The ordinal value of day of the year, as an integer. Category Date and time functions Function syntax DayOfYear("date") See also Day, DayOfWeek, DayOfWeekAsString, DaysInMonth, DaysInYear, FirstDayOfMonth Parameters Parameter Description date Date/time object, in the range 100 AD–9999 AD. Usage This function accounts for leap years. When passing a date/time object as a string, you must enclose it in quotation marks.
DaysInMonth Description Determines the number of days in a month. Returns The number of days in the month in Date. Category Date and time functions Function syntax DaysInMonth("date") See also Day, DayOfWeek, DayOfWeekAsString, DayOfYear, DaysInYear, FirstDayOfMonth Parameters Parameter Description date Date/time object, in the range 100 AD–9999 AD. Usage When passing a date/time object as a string, you must enclose it in quotation marks.
DaysInYear Description Determines the number of days in a year. Returns The number of days in a year. Category Date and time functions Function syntax DaysInYear("date") See also Day, DayOfWeek, DayOfWeekAsString, DayOfYear, DaysInMonth, DaysInYear, FirstDayOfMonth, IsLeapYear Parameters Parameter Description date • Date/time object, in the range 100 AD–9999 AD. Usage DaysInYear accounts for leap years. When passing a date/time object as a string, you must enclose it in quotation marks.
DE Description Escapes any double-quotation marks in the parameter and wraps the result in double-quotation marks. Returns Parameter, surrounded by double-quotation marks, with any inner double-quotation marks escaped.
The following example shows how you can use the DE function and number signs together, and shows how the function works with an IIF function: The expression is #myresult# ColdFusion processes this code as follows: 1. ColdFusion sets the variables var1 and var2 to be the strings Blue and Green. 2.
Sorry, there’s been an Error. Try a simple expression, such as "2+2". #cfcatch.
DecimalFormat Description Converts a number to a decimal-formatted string. Returns A number as a string formatted with two decimal places and a thousands separator. Category Display and formatting functions Function syntax DecimalFormat(number) See also DollarFormat, NumberFormat Parameters Parameter Description number Number to format Example DecimalFormat Function Returns a number to two decimal places.
DecrementValue Description Decrements the integer part of a number. Returns Integer part of number, decremented by one. Category Mathematical functions Function syntax DecrementValue(number) See also IncrementValue Parameters Parameter Description number Number to decrement Example DecrementValue Example Returns the integer part of a number decremented by one.
Decrypt Description Decrypts a string that is encrypted using a standard encryption technique, including strings encrypted by the Encrypt function. Returns An unencrypted string. Category Security functions, String functions Function syntax Decrypt(encrypted_string, key[, algorithm[, encoding]]) See also Duplicate, Encrypt ColdFusion MX 7: Added the algorithm and encoding parameters. Parameters Parameter Description encrypted_string String to decrypt. key String.
Usage This function uses a symmetric key-based algorithm, in which the same key is used to encrypt and decrypt a string. The parameter values must match the values used to encode string. The security of the encrypted string depends on maintaining the secrecy of the key. ColdFusion MX 7 uses the Java Cryptography Extension (JCE) and installs a Sun Java 1.4.2 runtime that includes the Sun JCE default security provider. This provider includes the algorithms listed in the Parameters section.
Select the algorithm
Input your key (used for CFMX_COMPAT encryption only)
Enter string to encrypt
|
