sysmail_update_profile_sp (Transact-SQL)

發行項
06/18/2013

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

語法

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，就必須利用三部分名稱來執行這個程序。

權限

這個程序的執行權限預設會授與系統管理員 (sysadmin) 固定伺服器角色的成員。

範例

A. 變更設定檔的描述

下列範例會變更 msdb 資料庫中，名稱為 AdventureWorks Administrator 之設定檔的描述。

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

B. 變更設定檔的名稱和描述

下列範例會變更設定檔識別碼為 750 之設定檔的名稱和描述。

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