ezAJAX ColdFusion Function Library

You may access the ezAJAX ColdFusion Function Library from within the “ezAJAX.cfc.userDefinedAJAXFunctions.cfc” file which has been made available to you in which you can implement your ezAJAX Server Commands.

ezCfMail(toAddrs,fromAddrs,theSubj,theBody,optionsStruct)

The “ezCfMail(toAddrs,fromAddrs,theSubj,theBody,optionsStruct)” function takes four required arguments which are “toAddrs” the email address to which the email is to be sent, the “fromAddrs” email address the email was sent from, the “theSubj” subject of the email and “theBody” the body of the email which can contain HTML. The optional argument “optionsStruct” allows a MIME attachment to be added to an email. Request.anError is a Boolean variable that will be “true” if a ColdFusion was thrown while the email was being sent or “false” if no Error was thrown. Request.errorMsg is a String variable that is either blank “” or contains an error message from the ColdFusion Error that was thrown.

The following code sample shows how a MIME attachment can be added to an email:

ezExecSQL(qName,DSN,sqlStatement)

The “ezExecSQL(qName,DSN,sqlStatement)” function takes three required arguments which are “qName” the name of the Query Object that holds the results of the ColdFusion Query, “DSN” the ColdFusion Data Source Name and “sqlStatement” the SQL Statement to be executed. It works best to make the Query Name a Global such as “Request.qName” to make it easier to perform Query of Queries using ColdFusion after this function completes. Request.errorMsg is a Boolean variable that will be “true” if a ColdFusion was thrown while the email was being sent or “false” if no Error was thrown. Request.dbError is a String variable that is either blank “” or contains an error message from the ColdFusion Error that was thrown. Request.isPKviolation is a Boolean variable that will be “true” if the SQL Statement resulted in a Primary Key Violation Error or “false” if no Primary Key Violation Error occurred. Request.explainError is a String variable that contains the ColdFusion Error explanation when Request.dbError is “true”. Request.explainErrorHTML is a String variable that contains the ColdFusion Error explanation that contains when Request.dbError is “true”. Request.moreErrorMsg is a String variable that contains a more verbose ColdFusion Error explanation when Request.dbError is “true”.

ezCfDirectory(qName,pathname,filter,recurse)

The “ezCfDirectory(qName,pathname,filter,recurse)” function takes three required arguments and one optional argument which are “qName” the name of the Query Object that holds the results of the <cfdirectory> function, the “pathName” fully qualified name of the directory, “filter” pattern of file names for which to Query and “recurse” optional Boolean that when “true” causes the <cfdirectory> function to search subdirectories in addition to the named directory. Request.directoryError is a Boolean variable that will be “true” if a ColdFusion was thrown while the email was being sent or “false” if no Error was thrown. Request.directoryErrorMsg is a String variable that is either blank “” or contains an error message from the ColdFusion Error that was thrown.

ezFilePathFromUrlUsingCommonFolder(url,path,cName)

The “ezFilePathFromUrlUsingCommonFolder(url,path,cName)” function takes three arguments which are “url” the URL for a document for which a fully qualified path is desired, “path” for a known path that resides within the same webspace as the file the URL points to and “cName” that is a known common name that exists within the fully qualified path names for both the “url” and the “path” and returns the fully qualified path for the “url”.

ezScopesDebugPanelContent()

The “ezScopesDebugPanelContent()” function takes no arguments and returns the HTML content for the following Scopes via a formatted <cfdump>: Application Scope, Session Scope, CGI Scope and Request Scope.

ezCfFileDelete(fName)

The “ezCfFileDelete(fName)” function takes one required argument that is “fName” the fully qualified file name to be deleted. Request.fileError is a Boolean variable that will be “true” if a ColdFusion was thrown while the email was being sent or “false” if no Error was thrown. Request.errorMsg is a String variable that is either blank “” or contains an error message from the ColdFusion Error that was thrown.

ezCfFileRead(fName,vName)

The “ezCfFileRead(fName,vName)” function takes two required arguments which are the “fName” fully qualified name of the file to be read and “vName” the variable name into which the contents of “fName” is placed. Request.fileError is a Boolean variable that will be “true” if a ColdFusion was thrown while the email was being sent or “false” if no Error was thrown. Request.errorMsg is a String variable that is either blank “” or contains an error message from the ColdFusion Error that was thrown.

ezCfFileWrite(fName,sOutput)

The “ezCfFileWrite(fName,sOutput)” function takes two required arguments which are the “fName” fully qualified name of the file to be written and “sOutput” the variable name from which the contents of “fName” is to be written. Request.fileError is a Boolean variable that will be “true” if a ColdFusion was thrown while the email was being sent or “false” if no Error was thrown. Request.errorMsg is a String variable that is either blank “” or contains an error message from the ColdFusion Error that was thrown.

ezCfExecute(exeName,sArgs,iTimeout)

The “ezCfExecute(exeName,sArgs,iTimeout)” function takes three required arguments which are the “exeName” fully qualified name of the file to be executed by the OS, “sArgs” String value that specifies the Arguments to be passed to the executable file and “iTimeout” the number of seconds after which the file execution request is to be considered to be timed-out. Request.execError is a Boolean variable that will be “true” if a ColdFusion was thrown while the email was being sent or “false” if no Error was thrown. Request.errorMsg is a String variable that is either blank “” or contains an error message from the ColdFusion Error that was thrown.

ezCfLog(sTextMsg)

The “ezCfLog(sTextMsg)” function takes one required argument that is “sTextMsg” the message that is to be logged in the standard ColdFusion Message Logging system.

ezCFML2WDDX(oObj)

The “ezCFML2WDDX(oObj)” function takes one required argument that is “oObj” a pointer to the ColdFusion Object that is to be converted into a WDDX data stream using the “CFML2WDDX” action. This function returns the WDDX data stream as requested.

ezWDDX2CFML(sWDDX)

The “ezWDDX2CFML(sWDDX)” function takes one required argument that is “sWDDX” a String value that points to a WDDX data stream that is converted back into a ColdFusion Object using the “WDDX2CFML” action. This function returns the ColdFusion Object as requested.