AgentProfile.Description Property

レプリケーション エージェント プロファイルの説明テキストを取得します。値の設定も可能です。

名前空間: Microsoft.SqlServer.Replication
アセンブリ: Microsoft.SqlServer.Rmo (microsoft.sqlserver.rmo.dll 内)

構文

'宣言
Public Property Description As String
public string Description { get; set; }
public:
property String^ Description {
    String^ get ();
    void set (String^ value);
}
/** @property */
public String get_Description ()

/** @property */
public void set_Description (String value)
public function get Description () : String

public function set Description (value : String)

プロパティ値

エージェント プロファイルの説明テキストを表す String 値です。

解説

Description プロパティは、読み取り/書き込みプロパティです。

Description プロパティを取得できるのは、ディストリビュータ側の固定サーバー ロール sysadmin のメンバ、または固定データベース ロールreplmonitor のメンバだけです。

Description プロパティを設定できるのは、ディストリビュータ側の固定サーバー ロール sysadmin のメンバだけです。

Description を取得すると、sp_help_agent_profile (Transact-SQL) を実行したのと同じことになります。

既存のプロファイルへの Description の設定と CommitPropertyChanges の呼び出しは、sp_change_agent_profile (Transact-SQL) を実行したのと同じことになります。

Description の設定と Create の呼び出しは、sp_add_agent_profile (Transact-SQL) を実行したのと同じことになります。

Description プロパティは、SQL Server 2005、SQL Server 2000、および SQL Server 7.0 で使用できます。

この名前空間、クラス、またはメンバは、.NET Framework 2.0 でのみサポートされています。

スレッド セーフ

この型の public static (Microsoft Visual Basic では共有 ) メンバは、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

開発プラットフォーム

サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。

対象プラットフォーム

サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。

参照

関連項目

AgentProfile Class
AgentProfile Members
Microsoft.SqlServer.Replication Namespace

その他の技術情報

レプリケーション エージェント プロファイルを扱う方法 (RMO プログラミング)