使用sp_addmessage添加自定义消息

使用sp_addmessage添加自定义消息
将新的用户定义错误消息存储在SQL Server Database Engine 实例中。

使用sp_addmessage 存储的消息可以使用sys.messages 目录视图进行查看。

语法
sp_addmessage [ @msgnum = ] msg_id , [ @severity = ] severity , [ @msgtext = ] 'msg'
[ , [ @lang = ] 'language' ]
[ , [ @with_log = ] 'with_log' ]
[ , [ @replace = ] 'replace' ]
备注
对于非英语版本的SQL Server，必须已经存在美国英语版本的消息，然后才能使用另一种语言添加消息。

两种消息版本的严重性必须匹配。

当本地化包含参数的消息时，使用与原始消息中的参数相应的参数。

在每个参数后都插入感叹号(!)。

由于语言语法不同，因此，本地化消息中的参数可能不会以原始消息中相同的顺序出现。

参数
[ @msgnum = ] msg_id
消息的ID。

msg_id 的数据类型为int，默认值为NULL。

用户定义错误消息的msg_id 可以是50,001 和
2,147,483,647 之间的整数。

msg_id 和language 的组合
必须是唯一的；如果特定语言的ID 已经存在，则返回错误。

[ @severity = ] severity
错误的严重级别。

severity 的数据类型为smallint，默认值为NULL。

有效级别从1 到25。

有关严重性的详细信息，请参阅数据库引擎错误严重性。

[ @msgtext = ] 'msg'
错误消息的文本。

msg 的数据类型为nvarchar(255)，默认值为NULL。

[ @lang = ] 'language'
该消息的语言。

language 的数据类型为sysname，默认值为
NULL。

由于可以在同一个服务器上安装多种语言，因此，
language 指定编写每个消息时所用的语言。

如果省略
language，则会话语言为默认语言。

[ @with_log = ] { 'TRUE' | 'FALSE' ] }
是否在消息发生时将其写入Windows 应用程序日志。

@with_log 的数据类型为varchar(5)，默认值为FALSE。

如
果为TRUE，则错误始终写入Windows 应用程序日志。

如果
为FALSE，则错误不会始终写入Windows 应用程序日志，但
仍然可以写入，具体取决于错误是如何引发的。

只有sysadmin 服务器角色的成员才能使用该选项。

注意：
[ @replace = ] 'replace'
如果指定为字符串replace，则会以新的消息正文和严重级别覆
盖现有错误消息。

@replace 为varchar(7)，默认值为NULL。

如果msg_id 已经存在，则必须指定该选项。

如果替换了美国
英语消息，则会以具有相同msg_id 的所有其他语言替换所有
消息的严重级别。

返回代码值
0（成功）或1（失败）
结果集
无
权限
要求具有sysadmin 和serveradmin 固定服务器角色的成员身份。

示例
A. 定义自定义的消息
以下示例将自定义的消息添加到sys.messages。

复制代码
USE master
GO
EXEC sp_addmessage 50001, 16,
N'Percentage expects a value between 20 and 100. Please reexecute with a more appropriate value.'; GO
B. 用两种语言添加消息
以下示例首先用美国英语添加一条消息，然后用法语添加相同的消息。

复制代码
USE master;
GO
EXEC sp_addmessage @msgnum = 60000, @severity = 16, @msgtext = N'The item named %s already exists in %s.', @lang = 'us_english';
EXEC sp_addmessage @msgnum = 60000, @severity = 16, @msgtext = N'L''élément nomm?%1! existe
déj?dans %2!',
@lang = 'French';
GO
C. 更改参数顺序
以下示例首先添加美国英语的消息，然后添加更改了其参数顺序的本地化消息。

复制代码
USEmaster;
GO
EXEC sp_addmessage
@msgnum = 60000,
@severity = 16,
@msgtext =
N'This is a test message with one numeric
parameter (%d), one string parameter (%s),
and another string parameter (%s).',
@lang = 'us_english';
EXEC sp_addmessage
@msgnum = 60000,
@severity = 16,
@msgtext =
-- In the localized version of the message,
-- the parameter order has changed. The
-- string parameters are first and second
-- place in the message, and the numeric
-- parameter is third place.
N'Dies ist eine Testmeldung mit einem
Zeichenfolgenparameter (%3!),
einem weiteren Zeichenfolgenparameter (%2!),
und einem numerischen Parameter (%1!).',
@lang = 'German';
GO
-- Changing the session language to use the U.S. English -- version of the error message.
SET LANGUAGE us_english;
GO
RAISERROR(60000,1,1,15,'param1','param2') -- error, severity, state,
GO -- parameters.
-- Changing the session language to use the German -- version of the error message.
SET LANGUAGE German;
GO
RAISERROR(60000,1,1,15,'param1','param2') -- error, severity, state,
GO -- parameters.。