Functions

Categories

NameNameName
Array Functions Exception Handling Functions Query Functions
Cache Functions Extensibility Functions Security Functions
Conversion Functions Full-text Search Functions String Functions
Data Output Functions Image Functions Structure Functions
Date And Time Functions International Functions System Functions
Debugging Functions List Functions Transaction Functions
Decision Functions Mathematical Functions XML Functions
Display And Formatting Functions ORM Functions
Dynamic Evaluation Functions Other Functions

All ColdFusion Functions

namedescription
absAbsolute-value function. The absolute value of a number is the number without its sign.
aCosArccosine function. The arccosine is the angle whose cosine is number.
addSOAPRequestHeaderAdds a SOAP header to a web service request before making the request.
addSOAPResponseHeaderAdds 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.
ajaxLinkCauses an HTML href attribute to display link results in the current Ajax container. When the browser follows a link that is specified by this function, the HTTP response does not replace the current page; instead, it populates the containing cfdiv, cflayoutarea, cfpod, or cfwindow control.
ajaxOnLoadCauses the specified JavaScript function to run when the page loads.
applicationStopStops or resets the current application. The application is restarted on the next request to the application.
arrayAppendAppends an array element to an array.
arrayAvgCalculates the average of the values in an array.
arrayClearDeletes the data in an array.
arrayContainsSearches an array for the presence of a specified object. The function searches simple objects such as strings and numbers or complex objects such as structures. String searches are case-sensitive. This function does not support searche for COM and CORBA objects.
arrayDeleteDeletes an element from an array. It does not support COM and CORBA objects.
arrayDeleteAtDeletes an element from a specified position in an array.
arrayFindThis function performs a case-sensitive search on an array for a specified object. The function can search for simple objects such as strings or numbers and complex objects such as structures. It does not support COM and CORBA objects.
arrayFindNoCaseThis function performs a case-insensitive search on an array for a specified object. The function can search for simple objects such as strings or numbers and complex objects such as structures. It does not support COM and CORBA objects.
arrayInsertAtInserts 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.
arrayIsDefinedDetermines whether an array element is defined.
arrayIsEmptyDetermines whether an array is empty of data elements.
arrayLenDetermines the number of elements in an array.
arrayMaxArray maximum function.
arrayMinArray minimum function.
arrayNewCreates an array of 1–3 dimensions. Index array elements with square brackets: [ ].
arrayPrependInserts an array element at the beginning of an array.
arrayResizeResets an array to a specified minimum number of elements. Resetting can improve performance, if used to size an array to its expected maximum. For more than 500 elements, use ArrayResize immediately after using the ArrayNew tag.
arraySetIn a one-dimensional array, sets the elements in a specified index range to a value. Useful for initializing an array after a call to ArrayNew.
arraySortSorts array elements numerically or alphanumerically.
arraySumArray sum function.
arraySwapSwaps array values of an array at specified positions. This function is more efficient than multiple cfset tags.
arrayToListConverts a one-dimensional array to a list.
ascDetermines the value of a character.
aSinDetermines the arcsine of a number. The arcsine is the angle whose sine is number.
atnArctangent function. The arctangent is the angle whose tangent is number.
binaryDecodeConverts a string to a binary object. Used to convert binary data that has been encoded into string format back into binary data.
binaryEncodeConverts binary data to a string.
bitAndPerforms a bitwise logical AND operation.
bitMaskClearPerforms a bitwise mask clear operation.
bitMaskReadPerforms a bitwise mask read operation.
bitMaskSetPerforms a bitwise mask set operation.
bitNotPerforms a bitwise logical NOT operation.
bitOrPerforms a bitwise logical OR operation.
bitSHLNPerforms a bitwise shift-left, no-rotation operation.
bitSHRNPerforms a bitwise shift-right, no-rotation operation.
bitXorPerforms a bitwise logical XOR operation.
cacheGetGets an object that is stored in the cache.
cacheGetAllIdsGets the IDs of all objects stored in the cache.
cacheGetMetadataGets the metadata values for a cached object.
cacheGetPropertiesGets the cache properties for the object cache, the page cache, or both. The information is application-specific.
cachePutStores an object in the cache.
cacheRemoveRemoves an object from the cache.
cacheSetPropertiesSets the cache properties for the object cache, the page cache, or both. If a cache does not yet exist, creates it. The cache and properties are application-specific.
ceilingDetermines the closest integer that is greater than a specified number.
charsetDecodeConverts a string to a binary representation.
charsetEncodeUses the specified encoding to convert binary data to a string.
chrConverts a numeric value to a UCS-2 character.
cJustifyCenters a string in a field length.
comparePerforms a case sensitive comparison of two strings.
compareNoCasePerforms a case-insensitive comparison of two strings.
cosCalculates the cosine of an angle that is entered in radians.
createDateCreates a date/time object.
createDateTimeCreates a date-time object.
createObjectCreates a ColdFusion object, of a specified type.
createODBCDateCreates an ODBC date object.
createODBCDateTimeCreates an ODBC date-time object.
createODBCTimeCreates an ODBC time object.
createTimeCreates a time variable.
createTimeSpanCreates a date/time object that defines a time period. You can add or subtract it from other date-time objects and use it with the cachedWithin attribute of cfquery.
createUUIDCreates a Universally Unique Identifier (UUID). A UUID is a 35-character string representation of a unique 128-bit integer.
dateAddAdds units of time to a date.
dateComparePerforms a full date/time comparison of two dates.
dateConvertConverts 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 necessary.
dateDiffDetermines the integer number of units by which date1 is less than date2.
dateFormatFormats a date value using U.S. date formats. For international date support, use LSDateFormat.
datePartExtracts a part from a date value.
dayDetermines the day of the month, in a date.
dayOfWeekDetermines the day of the week, in a date.
dayOfWeekAsStringDetermines the day of the week, in a date, as a string function.
dayOfYearDetermines the day of the year, in a date.
daysInMonthDetermines the number of days in a month.
daysInYearDetermines the number of days in a year.
dEEscapes any double-quotation marks in the parameter and wraps the result in double-quotation marks.
decimalFormatConverts a number to a decimal-formatted string.
decrementValueDecrements the integer part of a number.
decryptDecrypts a string that is encrypted using a standard encryption technique, including strings encrypted by the Encrypt function.
decryptBinaryDecrypts encrypted binary data with the specified key, value, algorithm, salt, and iterations.
deleteClientVariableDeletes a client variable. (To test for the existence of a variable, use IsDefined.)
deserializeJSONConverts a JSON (JavaScript Object Notation) string data representation into CFML data, such as a CFML structure or array.
directoryCreateCreates on-disk or in-memory directory.
directoryDeleteDeletes on-disk or in-memory directory.
directoryExistsDetermines whether on-disk or in-memory directory exists.
directoryListLists the contents of on-disk or in-memory directory. Also lists the contents of the sub-directories if recurse is set to true.
directoryRenameRenames on-disk or in-memory directory.
dollarFormatFormats a string in U.S. format. (For other currencies, use LSCurrencyFormat or LSEuroCurrencyFormat.
dotNetToCFTypeExplicitly converts a value returned by a .NET method to the corresponding ColdFusion data type.
duplicateReturns a clone, also known as a deep copy, of a variable. There is no reference to the original variable.
encryptEncrypts a string using a specific algorithm and encoding method.
encryptBinaryEncrypts binary data using a specific algorithm and encoding method.
entityDeleteDeletes the record from the database for the specified entity. Depending on the cascade attribute specified in the mapping, it deletes the associated objects also.
entityLoadLoads and returns an array of entities for the specified entity name. You can also specify a filter criteria and sort order. All EntityLoad methods take the entity name as input.
entityLoadByExampleLoads and returns an array of objects that match the sampleentity.The filter criteria is constructed by ANDing all the non-null properties of the sampleentity.
entityLoadByPKLoads and returns an array of objects for the specified primary key. Use this function to avoid specifying the boolean parameter that you must specify with the EntityLoad() function.
entityMergeAttaches the specified entity to the current ORM session. It copies the state of the given object onto the persistent object with the same identifier and returns the persistent object.
entityNewCreates a new instance of the persistent CFC with the entity name that you provide.
entityReloadReloads data for an entity that is already loaded. This method refetches data from the database and repopulates the entity with the refreshed data.
entitySaveSaves or updates data of the entity and all related entities to the database. ColdFusion automatically tries to find if a new record should be inserted or an existing record be updated for the given entity. If you set forceinsert=true, then ColdFusion tries to insert the entity as a new record.
entitytoQueryConverts the input entity object or the input array of entity objects to a query object.
evaluateEvaluates one or more string expressions, dynamically, from left to right. (The results of an evaluation on the left can have meaning in an expression to the right.) Returns the result of evaluating the rightmost expression.
expCalculates the exponent whose base is e that represents number. The constant e equals 2.71828182845904, the base of the natural logarithm. This function is the inverse of Log, the natural logarithm of number.
expandPathCreates an absolute, platform-appropriate path that is equivalent to the value of relative_path, appended to the base path. This function (despite its name) can accept an absolute or relative path in the relative_path parameter
fileCloseCloses an on-disk or in-memory file that is open. When you use the FileOpen function, ColdFusion returns a handle to a file object.When you close the file, the handle is still available; however, it lists the file as closed.
fileCopyCopies the specified on-disk or in-memory source file to the specified destination file.
fileDeleteDeletes the specified on-disk or in-memory file on the server.
fileExistsDetermines whether an on-disk or in-memory file exists.
fileIsEOFDetermines whether ColdFusion has reached the end of an on-disk or in-memory file while reading it.
fileMoveMoves an on-disk or in-memory file from one location to another on the server.
fileOpenOpens an on-disk or in-memory file to read, write, or append. Use this function with the FileRead function to read large files.
fileReadReads an on-disk or in-memory text file or a file object created with the FileOpen function. You use this function either as an alternative to the cffile tag with the action="read" attribute. You can also use this function to improve performance when reading a large file, because FileRead does not read the entire file into memory.
fileReadBinaryReads an on-disk or in-memory binary file (such as an executable or image file) on the server, into a binary object parameter that you can use in the page. To send it through a web protocol (such as HTTP or SMTP) or store it in a database, first convert it to Base64 by using the ToBase64 function.
fileReadLineReads a line from an on-disk or in-memory file.
fileSeekSeeks the position for read or write operation of an on-disk or in-memory file on the server.
fileSetAccessModeSets the attributes of an on-disk file on UNIX or Linux. This function does not work with in-memory files.
fileSetAttributeSets the attributes of an on-disk file in Windows. This function does not work with in-memory files.
fileSetLastModifiedSets the date when an on-disk or in-memory file was most recently modified.
fileSkipBytesSkips over the data before a read or write operation of an on-disk or in-memory file on the server.
fileWriteIf you specify a file path, writes the entire content to the specified on-disk or in-memory file. If you specify a file object, writes text or binary data to the file object.
findFinds the first occurrence of a substring in a string, from a specified start position. The search is case sensitive.
findNoCaseFinds the first occurrence of a substring in a string, from a specified start position. If substring is not in string, returns zero. The search is case-insensitive.
findOneOfFinds the first occurrence of any one of a set of characters in a string, from a specified start position. The search is case sensitive.
firstDayOfMonthDetermines the ordinal (day number, in the year) of the first day of the month in which a given date falls.
fixConverts a real number to an integer.
formatBaseNConverts number to a string, in the base specified by radix.
generateSecretKeyGets a secure key value for use in the Encrypt function.
getAuthUserGets the name of an authenticated user.
getBaseTagDataUsed within a custom tag. Finds calling (ancestor) tag by name and accesses its data.
getBaseTagListGets ancestor tag names, starting with the parent tag.
getBaseTemplatePathGets the absolute path of an application’s base page.
getClientVariablesListFinds the client variables to which a page has write access.
getComponentMetaDataGets metadata (such as the functions and implemented interfaces of a component) for a CFC or ColdFusion interface.
getContextRootReturns path to the J2EE server context root for the current request.
getCurrentTemplatePathGets the path of the page that calls this function.
getDirectoryFromPathExtracts a directory from an absolute on-disk or in-memory path.
getEncodingReturns the encoding (character set) of the Form or URL scope.
getExceptionUsed with the cftry and cfcatch tags. Retrieves a Java exception object from a Java object.
getFileFromPathExtracts a filename from an absolute on-disk or in-memory path.
getFileInfoRetrieves information about on-disk or in-memory file.
getFunctionCalledNameReturns the name of the variable used to call a defined function.
getFunctionListDisplays a list of the functions that are available in ColdFusion.
getGatewayHelperGets a Java GatewayHelper object that provides methods and properties for use with a ColdFusion event gateway.
getHttpRequestDataMakes HTTP request headers and body available to CFML pages. Useful for capturing SOAP request data, which can be delivered in an HTTP header.
getHttpTimeStringGets the current time, in the Universal Time code (UTC).
getK2ServerDocCountThis function is deprecated.
getK2ServerDocCountLimitThis function is deprecated.
getLocaleGets the current ColdFusion geographic/language locale value.
getLocaleDisplayNameGets a locale value and displays the name in a manner that is appropriate to a specific locale. By default, gets the current locale in the current locale’s language.
getLocalHostIPReturns the localhost IP address, which is 127.0.0.1 for IPv4 and ::1 for IPv6 addresses.
getMetaDataGets metadata (such as the methods, properties, and parameters of a component) associated with an object that is deployed on the ColdFusion server.
getMetricDataGets server performance metrics.
getPageContextGets the current ColdFusion PageContext object that provides access to page attributes and configuration, request, and response objects.
getPrinterInfoDetermines which print attributes are supported by a selected printer.
getProfileSectionsGets all the sections of an initialization file.
getProfileStringGets an initialization file entry.
getReadableImageFormatsReturns a list of image formats that ColdFusion can read on the operating system where ColdFusion is deployed.
getSOAPRequestReturns an XML object that contains the entire SOAP request. Usually called from within a web service CFC.
getSOAPRequestHeaderObtains a SOAP request header. Call only from within a CFC web service function that is processing a request as a SOAP web service.
getSOAPResponseReturns an XML object that contains the entire SOAP response after invoking a web service.
getSOAPResponseHeaderReturns a SOAP response header. Call this function from within code that is invoking a web service after making a web service request.
getTempDirectoryGets the path of the directory that ColdFusion uses for temporary files. The directory depends on the account under which ColdFusion is running and other factors. Before using this function in an application, test to determine the directory it returns under your account.
getTempFileCreates a temporary file in a directory whose name starts with (at most) the first three characters of prefix.
getTemplatePathThis function is deprecated. Use the GetBaseTemplatePath function instead.
getTickCountReturns the current value of an internal millisecond timer.
getTimeZoneInfoGets local time zone information for the computer on which it is called, relative to Universal Time Coordinated (UTC). UTC is the mean solar time of the meridian of Greenwich, England, used as the basis for calculating standard time throughout the world.
getTokenDetermines whether a token of the list in the delimiters parameter is present in a string.
getUserRolesRetrieves the list of roles for the current user. This function returns only ColdFusion roles, not roles set for the servlet API.
getWriteableImageFormatsReturns a list of image formats that ColdFusion can write on the operating system where ColdFusion is deployed.
hashConverts a variable-length string to a fixed-length string that can act as a “fingerprint” or unique identifier for the original string. It is not possible to convert the hash result back to the source string.
hourGets the current hour of the day.
hTMLCodeFormatReplaces special characters in a string with their HTML-escaped equivalents and inserts <pre> and </pre> tags at the beginning and end of the string.
hTMLEditFormatReplaces special characters in a string with their HTML-escaped equivalents.
iIfEvaluates a Boolean conditional dynamic expression. Depending on whether the expression is yes or no, dynamically evaluates one of two string expressions and returns the result. This function is convenient for incorporating a cfif tag in-line in HTML.
imageAddBorderAdds a rectangular border around the outside edge of a ColdFusion image.
imageBlurSmooths (blurs) the ColdFusion image.
imageClearRectClears the specified rectangle by filling it with the background color of the current drawing surface.
imageCopyCopies a rectangular area of an image.
imageCropCrops a ColdFusion image to a specified rectangular area.
imageDrawArcDraws a circular or elliptical arc.
imageDrawBeveledRectDraws a rectangle with beveled edges.
imageDrawCubicCurveDraws a cubic curve.
imageDrawLineDraws a single line defined by two sets of x and y coordinates on a ColdFusion image.
imageDrawLinesDraws a sequence of connected lines defined by arrays of x and y coordinates.
imageDrawOvalDraws an oval.
imageDrawPointDraws a point at the specified (x,y) coordinate.
imageDrawQuadraticCurveDraws a curved line. The curve is controlled by a single point.
imageDrawRectDraws a rectangle.
imageDrawRoundRectDraws a rectangle with rounded corners.
imageDrawTextDraws a text string on a ColdFusion image with the baseline of the first character positioned at (x,y) in the image.
imageFlipFlips an image across an axis.
imageGetBlobRetrieves the bytes of the underlying image. The bytes are in the same image format as the source image.
imageGetBufferedImageReturns the java.awt.BufferedImage object underlying the current ColdFusion image.
imageGetEXIFTagRetrieves the specified EXIF tag in an image.
imageGetHeightRetrieves the height of the ColdFusion image in pixels.
imageGetIPTCTagRetrieves the value of the IPTC tag for a ColdFusion image.
imageGetWidthRetrieves the width of the specified ColdFusion image.
imageGrayscaleConverts a ColdFusion image to grayscale.
imageInfoReturns a structure that contains information about the image, such as height, width, color model, size, and filename.
imageNegativeInverts the pixel values of a ColdFusion image.
imageNewCreates a ColdFusion image.
imageOverlayReads two source ColdFusion images and overlays the second source image on the first source image.
imagePasteTakes two images and an (x,y) coordinate and draws the second image over the first image with the upper-left corner at coordinate (x,y).
imageReadReads the on-disk or in-memory source pathname or URL and creates a ColdFusion image.
imageReadBase64Creates a ColdFusion image from a Base64 string.
imageResizeResizes a ColdFusion image.
imageRotateRotates a ColdFusion image at a specified point by a specified angle.
imageRotateDrawingAxisRotates all subsequent drawing on a ColdFusion image at a specified point by a specified angle.
imageScaleToFitCreates a resized image with the aspect ratio maintained.
imageSetAntialiasingSwitches antialiasing on or off in rendered graphics.
imageSetBackgroundColorSets the background color for the ColdFusion image. The background color is used for clearing a region. Setting the background color only affects the subsequent ImageClearRect calls.
imageSetDrawingColorSets the current drawing color for ColdFusion images. All subsequent graphics operations use the specified color.
imageSetDrawingStrokeSets the drawing stroke for points and lines in subsequent ColdFusion images.
imageSetDrawingTransparencySpecifies the degree of transparency of drawing functions.
imageSharpenSharpens a ColdFusion image by using the unsharp mask filter.
imageShearShears an image either horizontally or vertically. For each pixel (x, y) of the destination, the source value at the fractional subpixel position (x', y') is constructed with an Interpolation object and written to the destination.
imageShearDrawingAxisShears the drawing canvas.
imageTranslateCopies an image to a new location on the plane.
imageTranslateDrawingAxisTranslates the origin of the image context to the point (x,y) in the current coordinate system. Modifies the image context so that its new origin corresponds to the point (x,y) in the image’s original coordinate system.
imageWriteWrites a ColdFusion image to the specified on-disk or in-memory destination.
imageWriteBase64Writes Base64 images to the specified on-disk or in-memory destination.
imageXORDrawingModeSets the paint mode of the image to alternate between the image’s current color and the new specified color.
incrementValueAdds one to an integer.
inputBaseNConverts string, using the base specified by radix, to an integer.
insertInserts a substring in a string after a specified character position. If position=0, prefixes the substring to the string.
intCalculates the closest integer that is smaller than number. For example, it returns 3 for Int(3.3) and for Int(3.7); it returns -4 for Int(-3.3) and for Int(-3.7)
isArrayDetermines whether a value is an array.
isBinaryDetermines whether a value is stored as binary data.
isBooleanDetermines whether a value can be converted to Boolean
isCustomFunctionDetermines whether a name represents a custom function.
isDateDetermines whether a string or Java object can be converted to a date/time value.
isDDXDetermines whether a DDX file exists and is valid, or if a string contains valid DDX instructions.
isDebugModeDetermines whether debugging output is enabled.
isDefinedEvaluates a string value to determine whether the variable named in it exists.
isImageDetermines whether a variable returns a ColdFusion image.
isImageFileVerifies whether an image file is valid.
isInstanceOfDetermines whether an object is an instance of a ColdFusion interface or component, or of a Java class.
isJSONEvaluates whether a string is in valid JSON (JavaScript Object Notation) data interchange format.
isK2ServerABrokerThis function is deprecated.
isK2ServerDocCountExceededThis function is deprecated.
isK2ServerOnlineThis function is deprecated because the K2Server is always running when ColdFusion is running.
isLeapYearDetermines whether a year is a leap year.
isLocalHostDetermines whether the specified IP address is the localhost. This supports both IPv4 and IPv6 addresses.
isNullUsed to check if the given object or expression evaluates to null.
isNumericDetermines whether a string can be converted to a numeric value. Supports numbers in U.S. number format. For other number support, use LSIsNumeric.
isNumericDateEvaluates whether a real number is a valid representation of a date (date/time object).
isObjectDetermines whether a value is an object.
isPDFFileVerifies whether a PDF file is valid.
isPDFObjectDetermines whether a value is a PDF object.
isQueryDetermines whether value is a query.
isSimpleValueDetermines the type of a value.
isSOAPRequestDetermines whether a CFC is being called as a web service.
isStructDetermines whether a variable is a structure.
isUserInAnyRoleDetermines whether an authenticated user belongs to any role in a list of roles.
isUserInRoleDetermines whether an authenticated user belongs to the specified Role.
isUserLoggedInDetermines whether a user is logged in.
isValidTests whether a value meets a validation or data type rule.
isWDDXDetermines whether a value is a well-formed WDDX packet.
isXMLDetermines whether a string is well-formed XML text.
isXmlAttributeDetermines whether the function parameter is an XML Document Object Model (DOM) attribute node.
isXmlDocDetermines whether the function parameter is a ColdFusion XML document object.
isXmlElemDetermines whether the function parameter is an XML document object element.
isXmlNodeDetermines whether the function parameter is an XML document object node.
isXmlRootDetermines whether the function parameter is the root element of an XML document object.
javaCastConverts the data type of a ColdFusion variable to a specified Java type to pass as an argument to Java or .NET object. Use only for scalar, string, and array arguments.
jSStringFormatEscapes special JavaScript characters, such as single-quotation mark, double-quotation mark, and newline.
lCaseConverts the alphabetic characters in a string to lowercase.
leftReturns the leftmost count characters in a string.
lenDetermines the length of a string or binary object.
listAppendConcatenates a list or element to a list.
listChangeDelimsChanges a list delimiter.
listContainsDetermines the index of the first list element that contains a specified substring.
listContainsNoCaseDetermines the index of the first list element that contains a specified substring.
listDeleteAtDeletes an element from a list.
listFindDetermines the index of the first list element in which a specified value occurs. Case sensitive.
listFindNoCaseDetermines the index of the first list element in which a specified value occurs.
listFirstGets the first element of a list.
listGetAtGets a list element at a specified position.
listInsertAtInserts an element in a list.
listLastGets the last element of a list.
listLenDetermines the number of elements in a list.
listPrependInserts an element at the beginning of a list.
listQualifyInserts a string at the beginning and end of list elements.
listRestGets a list, without its first element.
listSetAtReplaces the contents of a list element.
listSortSorts list elements according to a sort type and sort order.
listToArrayCopies the elements of a list to an array.
listValueCountCounts instances of a specified value in a list. The search is case sensitive.
listValueCountNoCaseCounts instances of a specified value in a list. The search is case-insensitive.
lJustifyLeft justifies characters in a string of a specified length.
locationA function equivalent of the cflocation tag and is used in the <cfscript> mode.
logCalculates the natural logarithm of a number. Natural logarithms are based on the constant e (2.71828182845904).
log10Calculates the logarithm of number, to base 10.
lSCurrencyFormatFormats a number in a locale-specific currency format. For countries that use the euro, the result depends on the JVM.
lSDateFormatFormats the date part of a date/time value in a locale-specific format.
lSEuroCurrencyFormatFormats a number in a locale-specific currency format.
lSIsCurrencyDetermines whether a string is a valid representation of a currency amount in the current locale.
lSIsDateDetermines whether a string is a valid representation of a date/time value in the current locale.
lSIsNumericDetermines whether a string is a valid representation of a number in the current locale.
lSNumberFormatFormats a number in a locale-specific format.
lSParseCurrencyConverts a locale-specific currency string into a formatted number. Attempts conversion by comparing the string with each the three supported currency formats (none, local, international) and using the first that matches.
lSParseDateTimeConverts a string that is a valid date/time representation in the current locale into a date/time object.
lSParseEuroCurrencyFormats a locale-specific currency string as a number. Attempts conversion through each of the default currency formats (none, local, international). Ensures correct handling of euro currency for Euro zone countries.
lSParseNumberConverts a string that is a valid numeric representation in the current locale into a formatted number.
lSTimeFormatFormats the time part of a date/time string into a string in a locale-specific format.
lTrimRemoves leading spaces from a string.
maxDetermines the greater of two numbers.
midExtracts a substring from a string.
minDetermines the lesser of two numbers.
minuteExtracts the minute value from a date/time object.
monthExtracts the month value from a date/time object.
monthAsStringDetermines the name of the month that corresponds to month_number.
nowGets the current date and time of the computer running the ColdFusion server. The return value can be passed as a parameter to date functions such as DaysInYear or FirstDayOfMonth.
numberFormatCreates a custom-formatted number value. Supports the numeric formatting used in the U.S. For international number formatting, see LSNumberFormat.
objectEqualsIdentifies any conflict between CFC instances on the client and the server.
objectLoadLoads a serialized ColdFusion array, CFC, DateTime object, Java object, query, or structure into memory as the corresponding object.
objectSaveConverts a ColdFusion array, CFC, DateTime object, Java object, query, or structure into a serializable binary object and optionally saves the object in a file.
oRMClearSessionORMClearSession removes all the entities that are loaded or created in the session. This clears the first level cache and removes the objects that are not yet saved to the database.
oRMCloseSessionCloses the current ORM session.
oRMEvictCollectionThis method is used to evict all the collection or association data for the given entity name and collection name, from the secondary cache. If the primary key is specified, then, the collection or association data of the entity with the primary key is evicted.
oRMEvictEntityThis method is used to evict items for the given entity name, from the secondary cache. If the primary key is specified, then the data of the entity with that primary key is evicted. Primary key should be a value in case of simple primary key or should be a struct in case of composite primary key.
oRMEvictQueriesThis method is used to evict the data of all the queries from the default query cache. If cache name is specified, then, the data of all the queries belonging to the cache region with the given cache name are evicted.
oRMExecuteQueryExecutes an Hibernate Query Language (HQL) query.
oRMFlushFlushes the current ORM session. ORMFlush flushes all the pending CRUD operations in that request. Any changes made in the objects, in the current ORM session, are saved to the database.
oRMGetSessionReturns the current ORM session (the underlying Hibernate session). Use this session object to call the APIs, which are otherwise not exposed by ColdFusion.
oRMGetSessionFactoryORMGetSessionFactory returns the underlying Hibernate SessionFactory object. For information on Session API see:
oRMReloadReinitializes ORM for the application.
paragraphFormatReplaces characters in a string:
parseDateTimeParses a date/time string according to the English (U.S.) locale conventions. (To format a date/time string for other locales, use the LSParseDateTime function.)
piGets the mathematical constant p, accurate to 15 digits.
precisionEvaluateEvaluates one or more string expressions, dynamically, from left to right, using BigDecimal precision arithmetic to calculate the values of arbitrary precision arithmetic expressions.
preserveSingleQuotesPrevents ColdFusion from automatically escaping single-quotation mark characters that are contained in a variable. ColdFusion does not evaluate the argument.
quarterCalculates the quarter of the year in which a date falls.
queryAddColumnAdds a column to a query and populates its rows with the contents of a one-dimensional array. Pads query columns, if necessary, to ensure that all columns have the same number of rows.
queryAddRowAdds a specified number of empty rows to a query.
queryConvertForGridConverts query data to a structure that contains a paged subset of the query. Used in CFC functions that return data to Ajax format cfgrid controls in response to a bind expression.
queryNewCreates an empty query (query object).
querySetCellSets a cell to a value. If no row number is specified, the cell on the last row is set.
quotedValueListGets the values of each record returned from an executed query. ColdFusion does not evaluate the arguments.
randGenerates a pseudo-random number.
randomizeSeeds the pseudo-random number generator with an integer number, ensuring repeatable number patterns.
randRangeGenerates a pseudo-random integer in the range between two specified numbers.
rEFindUses a regular expression (RE) to search a string for a pattern. The search is case sensitive.
rEFindNoCaseUses a regular expression (RE) to search a string for a pattern, starting from a specified position. The search is case-insensitive.
releaseComObjectReleases a COM Object and frees up resources that it used.
rEMatchUses a regular expression (RE) to search a string for a pattern, starting from a specified position. The search is case sensitive.
rEMatchNoCaseUses a regular expression (RE) to search a string for a pattern, starting from a specified position. The search is case-insensitive.
removeCharsRemoves characters from a string.
repeatStringCreates a string that contains a specified number of repetitions of the specified string.
replaceReplaces occurrences of substring1 in a string with substring2, in a specified scope. The search is case sensitive.
replaceListReplaces occurrences of the elements from a delimited list in a string with corresponding elements from another delimited list. The search is case sensitive.
replaceNoCaseReplaces occurrences of substring1 with substring2, in the specified scope. The search is case-insensitive.
rEReplaceUses a regular expression (RE) to search a string for a string pattern and replace it with another. The search is case sensitive.
rEReplaceNoCaseUses a regular expression to search a string for a string pattern and replace it with another. The search is case-insensitive.
reverseReverses the order of items, such as the characters in a string or the digits in a number.
rightGets a specified number of characters from a string, beginning at the right.
rJustifyRight justifies characters of a string.
roundRounds a number to the closest integer that is larger than the input parameter.
rTrimRemoves spaces from the end of a string.
secondExtracts the ordinal for the second from a date/time object.
sendGatewayMessageSends an outgoing message through a ColdFusion event gateway.
serializeJSONConverts ColdFusion data into a JSON (JavaScript Object Notation) representation of the data.
setLocaleSets the country/language locale for ColdFusion processing and the page returned to the client. The locale value determines the default format of date, time, number, and currency values, according to language and regional conventions.
setProfileStringSets the value of a profile entry in an initialization file.
setVariableSets a variable in the name parameter to the value of the value parameter.
sgnDetermines the sign of a number.
sinCalculates the sine of an angle that is entered in radians.
sleepCauses the current thread to stop processing for a specified period of time.
spanExcludingGets characters from a string, from the beginning and stops when it encounters any of the characters in a specified set of characters. The search is case sensitive.
spanIncludingGets characters from a string, from the beginning and stops when it encounters any character that is not in a specified set of characters. The search is case sensitive.
sqrCalculates the square root of a number.
stripCRDeletes return characters from a string.
structAppendAppends one structure to another.
structClearRemoves all data from a structure.
structCopyCopies a structure. Copies top-level keys, values, and arrays in the structure by value; copies nested structures by reference.
structCountCounts the keys in a structure.
structDeleteRemoves an element from a structure.
structFindDetermines the value associated with a key in a structure.
structFindKeySearches recursively through a substructure of nested arrays, structures, and other elements, for structures whose values match the search key in the value parameter.
structFindValueSearches recursively through a substructure of nested arrays, structures, and other elements for structures with values that match the search key in the valueparameter.
structGetGets a structure(s) from a specified path.
structInsertInserts a key-value pair into a structure.
structIsEmptyDetermines whether a structure contains data.
structKeyArrayFinds the keys in a ColdFusion structure.
structKeyExistsDetermines whether a specific key is present in a structure.
structKeyListExtracts keys from a ColdFusion structure.
structNewCreates a structure.
structSortReturns a sorted array of the top level keys in a structure. Sorts using alphabetic or numeric sorting, and can sort based on the values of any structure element.
structUpdateUpdates a key with a value.
tanCalculates the tangent of an angle that is entered in radians.
throwA function equivalent of the cfthrow tag and is used in the <cfscript> mode.
timeFormatFormats a time value using U.S. English time formatting conventions.
toBase64Calculates the Base64 representation of a string or binary object. The Base64 format uses printable characters, allowing binary data to be sent in forms and e-mail, and stored in a database or file.
toBinaryCalculates the binary representation of Base64-encoded data or of a PDF document.
toScriptCreates a JavaScript or ActionScript expression that assigns the value of a ColdFusion variable to a JavaScript or ActionScript variable. This function can convert ColdFusion strings, numbers, arrays, structures, and queries to JavaScript or ActionScript syntax that defines equivalent variables and values.
toStringConverts a value to a string.
traceA function equivalent of the <cftrace> tag and is used in the <cfscript> mode.
transactionCommitCommits the current active transaction.
transactionRollbackRolls back the current active transaction to the specified savepoint.
transactionSetSavePointCreates and stores a new savepoint for the current transaction. You can add multiple savepoints by calling this function multiple times.
trimRemoves leading and trailing spaces and control characters from a string.
uCaseConverts the alphabetic characters in a string to uppercase.
uRLDecodeDecodes a URL-encoded string.
uRLEncodedFormatGenerates a URL-encoded string. For example, it replaces spaces with %20, and non-alphanumeric characters with equivalent hexadecimal escape sequences. Passes arbitrary strings within a URL (ColdFusion automatically decodes URL parameters that are passed to a page).
uRLSessionFormatDepending on whether a client computer accepts cookies, this function does the following:
valConverts numeric characters that occur at the beginning of a string to a number.
valueListInserts a delimiter between each value in an executed query. ColdFusion does not evaluate the arguments.
verifyClientRequires remote invocations of the page or calls to functions on the page to include an encrypted security token.
weekFrom a date/time object, determines the week number within the year.
wrapWraps text so that each line has a specified maximum number of characters.
writedumpA function equivalent to the <cfdump> tag which can be used in <cfscript>.
writelogA function equivalent of the cflog tag, which can be used in <cfscript>.
writeOutputAppends text to the page-output stream.
xmlChildPosGets the position of a child element within an XML document object.
xmlElemNewCreates an XML document object element.
xmlFormatEscapes special XML characters in a string so that the string can be used as text in XML.
xmlGetNodeTypeDetermines the type of an XML document object node.
xmlNewCreates an XML document object.
xmlParseConverts XML text into an XML document object.
xmlSearchUses an XPath language expression to search an XML document object.
xmlTransformApplies an Extensible Stylesheet Language Transformation (XSLT) to XML. The XML can be in string format or an XML document object.
xmlValidateUses a Document Type Definition (DTD) or XML Schema to validate an XML text document or an XML document object.
yearFrom a date/time object, gets the year value.
yesNoFormatEvaluates a number or Boolean value.