sysmail_help_profile_sp (Transact-SQL)
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 つの要素を指定する必要があります。
権限
このプロシージャの実行権限は、既定では sysadmin 固定サーバー ロールのメンバーに与えられています。
使用例
A. すべてのプロファイルを一覧表示する
次の例では、インスタンス内のすべてのプロファイルを一覧表示します。
EXECUTE 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 に関する情報を一覧表示します。
EXECUTE msdb.dbo.sysmail_help_profile_sp
@profile_name = 'AdventureWorks Administrator' ;
次に結果セットを示します。行の長さは調整されています。
profile_id name description
----------- ----------------------------- ------------------------------
56 AdventureWorks Administrator Administrative mail profile.
関連項目
参照
データベース メール ストアド プロシージャ (Transact-SQL)