AgentProfile.AssignToAgent メソッド
特定のレプリケーション エージェント ジョブにレプリケーション エージェント プロファイルを割り当てます。
名前空間: Microsoft.SqlServer.Replication
アセンブリ: Microsoft.SqlServer.Rmo (Microsoft.SqlServer.Rmo.dll)
構文
'宣言
Public Sub AssignToAgent ( _
distributionDBName As String, _
agentId As Integer _
)
'使用
Dim instance As AgentProfile
Dim distributionDBName As String
Dim agentId As Integer
instance.AssignToAgent(distributionDBName, _
agentId)
public void AssignToAgent(
string distributionDBName,
int agentId
)
public:
void AssignToAgent(
String^ distributionDBName,
int agentId
)
member AssignToAgent :
distributionDBName:string *
agentId:int -> unit
public function AssignToAgent(
distributionDBName : String,
agentId : int
)
パラメーター
- distributionDBName
型: System.String
レプリケーション エージェント ジョブによって使用されるディストリビューション データベースの名前を指定する String 値です。
- agentId
型: System.Int32
例外
| 例外 | 条件 |
|---|---|
| ApplicationException | オブジェクトによって表されるプロファイルがサーバーに存在しない場合に発生します。 |
| ArgumentException | distributionDBName が nullNULL 参照 (Visual Basic では Nothing) であるか、nullNULL 参照 (Visual Basic では Nothing) 文字を含むか、128 Unicode 文字より長い場合に発生します。 |
説明
レプリケーション エージェント プロファイルを割り当てるには、対象のレプリケーション エージェント ジョブがデータベース上に作成されている必要があります。また、正しい種類のレプリケーション エージェントのエージェント ジョブに対してのみ、割り当てることができます。
AssignToAgent を呼び出すと、サーバーからプロファイル プロパティが読み込まれます。 このメソッドを呼び出す前にプロパティの変更をコミットするには、CommitPropertyChanges を呼び出します。
AssignToAgent メソッドを呼び出すことができるのは、ディストリビューター側の固定サーバー ロール sysadmin のメンバーだけです。
AssignToAgent を呼び出すと、sp_update_agent_profile (Transact-SQL) を実行したのと同じことになります。
関連項目
参照
Microsoft.SqlServer.Replication 名前空間