Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update cfcatch.json #1676

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions data/en/cfcatch.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
"related":["cftry","cffinally"],
"description":"Used inside a cftry tag. Together, they catch and process\n exceptions in CFML pages. Exceptions are events that\n disrupt the normal flow of instructions in a CFML page,\n such as failed database operations, missing include files, and\n developer-specified events.",
"params": [
{"name":"type","description":"`application`: catches application exceptions\n`database`: catches database exceptions\n`template`: catches ColdFusion page exceptions\n`security`: catches security exceptions\n`object`: catches object exceptions\n`missingInclude`: catches missing include file exceptions\n`expression`: catches expression exceptions\n`lock`: catches lock exceptions\n`custom_type`: catches the specified custom exception type that is defined in a cfthrow tag\n `java.lang.Exception`: catches Java object exceptions\n `searchengine`: catches Verity search engine exceptions\n `any`: catches all exception types","required":false,"default":"any","type":"string","values":["application","database","template","security","object","missinginclude","expression","lock","custom_type","searchengine","any"]}

{"name":"type","description":"`application`: catches application exceptions\n`database`: catches database exceptions\n`template`: catches ColdFusion page exceptions\n`security`: catches security exceptions\n`object`: catches object exceptions\n`missingInclude`: catches missing include file exceptions\n`expression`: catches expression exceptions\n`lock`: catches lock exceptions\n`custom_type`: catches the specified custom exception type that is defined in a cfthrow tag\n `java.lang.Exception`: catches Java object exceptions\n `searchengine`: catches Verity search engine exceptions\n `any`: catches all exception types","required":false,"default":"any","type":"string","values":["application","database","template","security","object","missinginclude","expression","lock","custom_type","searchengine","any"]},
{"name":"output","description":"Within a cfcatch block, the active exception property structure can be accessed as the following variables:","type":"struct","values":["`cfcatch.type`: Type: Exception type, as specified in cfcatch.","`cfcatch.message`: Message: Exception's diagnostic message, if provided; otherwise, an empty string; in the cfcatch.message variable.","`cfcatch.detail`: Detailed message from the CFML interpreter or specified in a cfthrow tag. When the exception is generated by ColdFusion (and not cfthrow), the message can contain HTML formatting and can help determine which tag threw the exception.","`cfcatch.tagcontext`: An array of tag context structures, each representing one level of the active tag context at the time of the exception.","`cfcatch.NativeErrorCode`: Applies to type = \"database\". Native error code associated with exception. Database drivers typically provide error codes to diagnose failing database operations. Default value is -1.","`cfcatch.SQLState`: Applies to type = \"database\". SQLState associated with exception. Database drivers typically provide error codes to help diagnose failing database operations. Default value is 1.","`cfcatch.Sql`: Applies to type = \"database\". The SQL statement sent to the data source.","`cfcatch.queryError`: Applies to type =\"database\". The error message as reported by the database driver.","`cfcatch.where`: Applies to type= \"database\". If the query uses the cfqueryparam tag, query parameter name-value pairs.","`cfcatch.ErrNumber`: Applies to type = \"expression\". Internal expression error number.","`cfcatch.MissingFileName`: Applies to type = \"missingInclude\". Name of file that could not be included.","`cfcatch.LockName`: Applies to type = \"lock\". Name of affected lock (if the lock is unnamed, the value is \"anonymous\").","`cfcatch.LockOperation`: Applies to type = \"lock\". Operation that failed (Timeout, Create Mutex, or Unknown).","`cfcatch.ErrorCode`: Applies to type = \"custom\". String error code.","`cfcatch.ExtendedInfo`: Applies to type = \"application\" and \"custom\". Custom error message; information that the default exception handler does not display."]}
],
"engines": {
"coldfusion": {"minimum_version":"4", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-tags/tags-c/cfcatch.html"},
Expand Down
Loading