RAISERROR Statement [T-SQL]

Syntax

RAISERROR error-number [ format-string ] [, arg-list ]

Parameters

error-number – a 5-digit integer greater than 17000. The error number is stored in the global variable @@error.

format-string – if not supplied or is empty, the error number is used to locate an error message in the system tables. Adaptive Server Enterprise obtains messages 17000-19999 from the SYSMESSAGES table. In SAP Sybase IQ, this table is an empty view, so errors in this range should provide a format string. Messages for error numbers of 20000 or greater are obtained from the SYS.SYSUSERMESSAGES table.
The format-string can be up to 255 bytes long. This is the same as in Adaptive Server Enterprise.

The format string can contain placeholders for the arguments in the optional argument list. These placeholders are of the form %nn!, where nn is an integer between 1 and 20.

Examples

Example 1 – raises error 99999, which is in the range for user-defined errors, and send a message to the client:
```
RAISERROR 99999 'Invalid entry for this 
column: %1!', @val
```

Usage

There is no comma between the error-number and the format-string parameters. The first item following a comma is interpreted as the first item in the argument list.

The extended values supported by the SQL Server or Adaptive Server Enterprise RAISERROR statement are not supported in SAP Sybase IQ.

Intermediate RAISERROR status and code information is lost after the procedure terminates. If at return time an error occurs along with the RAISERROR, then the error information is returned and the RAISERROR information is lost. The application can query intermediate RAISERROR statuses by examining @@error global variable at different execution points.

Standards

SQL—Transact-SQL extension to ISO/ANSI SQL grammar.
Sybase—Supported by Adaptive Server Enterprise.

Permissions

Must be connected to the database.