sysmail_update_profile_sp (Transact-SQL)

项目
03/07/2014

更改数据库邮件配置文件的说明或名称。

适用范围：SQL Server（SQL Server 2008 到当前版本）。

语法

sysmail_update_profile_sp [ [ @profile_id = ] profile_id , ] [ [ @profile_name = ] 'profile_name' , ]
    [ [ @description = ] 'description' ]

参数

[ @profile_id = ] profile_id
要更新的配置文件 ID。 profile_id 的数据类型为 int，默认值为 NULL。至少必须指定 profile_id 或 profile_name 中的一项。如果同时指定二者，则过程将更改配置文件的名称。
[ @profile_name = ] 'profile_name'
要更新的配置文件名称或配置文件的新的名称。 profile_name 的数据类型为 sysname，默认值为 NULL。至少必须指定 profile_id 或 profile_name 中的一项。如果同时指定二者，则过程将更改配置文件的名称。
[ @description = ] 'description'
对配置文件的新的说明。 description 的数据类型为 nvarchar(256)，默认值为 NULL。

返回代码值

0（成功）或 1（失败）

注释

如果同时指定了配置文件 ID 和配置文件名称，则该过程会将配置文件名称更改为所提供的名称，并更新配置文件的说明。当只提供其中的一个参数时，该过程会更新配置文件的说明。

存储过程 sysmail_update_profile_sp 位于 msdb 数据库中，由 dbo 架构所拥有。如果当前数据库不是 msdb，则该过程必须使用由三部分组成的名称执行。

权限

此过程的执行权限默认授予 sysadmin 固定服务器角色的成员。

示例

A. 更改配置文件的说明

以下示例更改 msdb 数据库中名为 AdventureWorks Administrator 的配置文件的说明。

EXECUTE msdb.dbo.sysmail_update_profile_sp
    @profile_name = 'AdventureWorks Administrator'
    ,@description = 'Administrative mail profile.';

B. 更改配置文件的名称和说明

以下示例更改配置文件 ID 为 750 的配置文件的名称和说明。

EXECUTE msdb.dbo.sysmail_update_profile_sp
    @profile_id = 750
    ,@profile_name = 'Operator'
    ,@description = 'Profile to send alert e-mail to operators.';