sysmail_update_profile_sp (Transact-SQL)

適用於:SQL Server

變更 Database Mail 設定檔的描述或名稱。

Transact-SQL 語法慣例

語法

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

引數

[ @profile_id = ] profile_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 (失敗)。

備註

指定設定檔識別碼和設定檔名稱時,程式會將配置檔的名稱變更為提供的名稱,並更新配置檔的描述。 只提供其中一個自變數時,程式會更新配置檔的描述。

預存程式 sysmail_update_profile_sp 位於 msdb 資料庫中,且由 dbo 架構所擁有。 如果目前的資料庫不是 msdb,則必須使用三部分名稱執行程式。

權限

此預存程式是由 db_owner 角色所擁有。 您可以授與 EXECUTE 任何用戶的許可權,但這些許可權可能會在 SQL Server 升級期間覆寫。

範例

A. 變更配置檔的描述

下列範例會變更資料庫中名為 AdventureWorks Administratormsdb 之配置檔的描述。

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

B. 變更配置檔的名稱和描述

下列範例會使用設定檔標識碼 來變更配置檔 750的名稱和描述。

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