AgentProfile.AssignToAgent Method
特定のレプリケーション エージェント ジョブにレプリケーション エージェント プロファイルを割り当てます。
名前空間: Microsoft.SqlServer.Replication
アセンブリ: Microsoft.SqlServer.Rmo (microsoft.sqlserver.rmo.dll 内)
構文
'宣言
Public Sub AssignToAgent ( _
distributionDBName As String, _
agentId As Integer _
)
public void AssignToAgent (
string distributionDBName,
int agentId
)
public:
void AssignToAgent (
String^ distributionDBName,
int agentId
)
public void AssignToAgent (
String distributionDBName,
int agentId
)
public function AssignToAgent (
distributionDBName : String,
agentId : int
)
パラメータ
- distributionDBName
レプリケーション エージェント ジョブによって使用されるディストリビューション データベースの名前を指定する、String 値です。
- agentId
例外
例外の種類 | 条件 |
---|---|
ApplicationException | オブジェクトによって表されるプロファイルがサーバーに存在しない場合に発生します。 |
ArgumentException | distributionDBName が null であるか、null 文字を含むか、128 Unicode 文字より長い場合に発生します。 |
解説
レプリケーション エージェント プロファイルを割り当てるには、対象のレプリケーション エージェント ジョブがデータベース上に作成されている必要があります。また、正しい種類のレプリケーション エージェントのエージェント ジョブに対してのみ、割り当てることができます。
AssignToAgent を呼び出すと、サーバーからプロファイル プロパティが読み込まれます。このメソッドを呼び出す前にプロパティの変更をコミットするには、CommitPropertyChanges を呼び出します。
AssignToAgent メソッドを呼び出すことができるのは、ディストリビュータ側の固定サーバー ロール sysadmin のメンバだけです。
AssignToAgent を呼び出すと、sp_update_agent_profile (Transact-SQL) を実行したのと同じことになります。
この名前空間、クラス、またはメンバは、.NET Framework 2.0 でのみサポートされています。
スレッド セーフ
この型の public static (Microsoft Visual Basic では共有 ) メンバは、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。
プラットフォーム
開発プラットフォーム
サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。
対象プラットフォーム
サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。
参照
関連項目
AgentProfile Class
AgentProfile Members
Microsoft.SqlServer.Replication Namespace