sysmail_help_profile_sp (Transact-SQL)
適用対象: SQL Server
1 つ以上のメール プロファイルに関する情報を一覧表示します。
構文
sysmail_help_profile_sp [ [ @profile_id = ] profile_id | [ @profile_name = ] 'profile_name' ]
[ ; ]
引数
[ @profile_id = ] profile_id
情報を返すプロファイル ID。 @profile_id は int で、既定値は NULL
です。
[ @profile_name = ] 'profile_name'
情報を返すプロファイル名。 @profile_name は sysname で、既定値は NULL
です。
リターン コードの値
0
(成功) または 1
(失敗)。
結果セット
次の列を含む結果セットが返されます。
列名 | データ型 | 説明 |
---|---|---|
profile_id |
int | プロファイルのプロファイル ID。 |
name |
sysname | プロファイルのプロファイル名。 |
description |
nvarchar (256) | プロファイルの説明。 |
解説
プロファイル名またはプロファイル ID を指定すると、 sysmail_help_profile_sp
はそのプロファイルに関する情報を返します。 それ以外の場合、 sysmail_help_profile_sp
は SQL Server インスタンス内のすべてのプロファイルに関する情報を返します。
ストアド プロシージャ sysmail_help_profile_sp
は msdb
データベースにあり、 dbo スキーマによって所有されます。 現在のデータベースが msdb
されていない場合は、プロシージャを 3 部構成の名前で実行する必要があります。
アクセス許可
この手順では EXECUTE
アクセス許可を付与できますが、これらのアクセス許可は SQL Server のアップグレード中にオーバーライドされる可能性があります。
例
A. すべてのプロファイルを一覧表示する
次の例は、インスタンス内のすべてのプロファイルの一覧を示しています。
EXEC msdb.dbo.sysmail_help_profile_sp;
行の長さのために再フォーマットされたサンプル結果セットを次に示します。
profile_id name description
----------- ----------------------------- ------------------------------
56 AdventureWorks Administrator Administrative mail profile.
57 AdventureWorks Operator Operator mail profile.
B. 特定のプロファイルを一覧表示する
次の例では、プロファイル AdventureWorks Administrator
に関する情報を一覧表示します。
EXEC msdb.dbo.sysmail_help_profile_sp
@profile_name = 'AdventureWorks Administrator' ;
行の長さのために再フォーマットされたサンプル結果セットを次に示します。
profile_id name description
----------- ----------------------------- ------------------------------
56 AdventureWorks Administrator Administrative mail profile.