SyncAdapter.DeleteCommand プロパティ

サーバー データベースからデータを削除するために使用されるクエリまたはストアド プロシージャを取得または設定します。

名前空間: Microsoft.Synchronization.Data.Server
アセンブリ: Microsoft.Synchronization.Data.Server (microsoft.synchronization.data.server.dll 内)

構文

'宣言
Public Property DeleteCommand As IDbCommand
'使用
Dim instance As SyncAdapter
Dim value As IDbCommand

value = instance.DeleteCommand

instance.DeleteCommand = value

public IDbCommand DeleteCommand { get; set; }

public:
property IDbCommand^ DeleteCommand {
    IDbCommand^ get ();
    void set (IDbCommand^ value);
}

/** @property */
public IDbCommand get_DeleteCommand ()

/** @property */
public void set_DeleteCommand (IDbCommand value)

public function get DeleteCommand () : IDbCommand

public function set DeleteCommand (value : IDbCommand)

プロパティ値

クエリまたはストアド プロシージャを格納する IDbCommand オブジェクト。

解説

同期アダプター コマンドにより、サーバー データベースから選択しサーバー データベースに変更を適用するのに使用されるクエリとストアド プロシージャを指定できるようになります。詳細については、「スナップショット、ダウンロード、アップロード、および双方向の各同期を指定する方法」を参照してください。各コマンドは、同期中に値を渡すことができるセッション変数を使用します。これらの変数は、ADO.NET コマンドのクエリやストアド プロシージャに対する他のパラメーターと同じように指定します。詳細については、「セッション変数を使用する方法」を参照してください。

例

次のコード例は、双方向でアップロードのみの同期シナリオで Customer テーブルから行を削除するコマンドを作成します。コマンドは、データベース プロバイダーのセットアップ スクリプトに関するトピック で定義されているストアド プロシージャです。完全なコンテキスト例でこのコードを表示するには、「データの競合とエラーを処理する方法」を参照してください。

SqlCommand customerDeletes = new SqlCommand();
customerDeletes.CommandType = CommandType.StoredProcedure;
customerDeletes.CommandText = "usp_CustomerApplyDelete";
customerDeletes.Parameters.Add("@" + SyncSession.SyncLastReceivedAnchor, SqlDbType.Timestamp);
customerDeletes.Parameters.Add("@" + SyncSession.SyncClientId, SqlDbType.UniqueIdentifier);
customerDeletes.Parameters.Add("@" + SyncSession.SyncForceWrite, SqlDbType.Bit);           
customerDeletes.Parameters.Add("@" + SyncSession.SyncRowCount, SqlDbType.Int).Direction = ParameterDirection.Output;
customerDeletes.Parameters.Add("@CustomerId", SqlDbType.UniqueIdentifier);
customerDeletes.Connection = serverConn;
customerSyncAdapter.DeleteCommand = customerDeletes;

Dim customerDeletes As New SqlCommand()
customerDeletes.CommandType = CommandType.StoredProcedure
customerDeletes.CommandText = "usp_CustomerApplyDelete"
customerDeletes.Parameters.Add("@" + SyncSession.SyncLastReceivedAnchor, SqlDbType.Timestamp)
customerDeletes.Parameters.Add("@" + SyncSession.SyncClientId, SqlDbType.UniqueIdentifier)
customerDeletes.Parameters.Add("@" + SyncSession.SyncForceWrite, SqlDbType.Bit)
customerDeletes.Parameters.Add("@" + SyncSession.SyncRowCount, SqlDbType.Int).Direction = ParameterDirection.Output
customerDeletes.Parameters.Add("@CustomerId", SqlDbType.UniqueIdentifier)
customerDeletes.Connection = serverConn
customerSyncAdapter.DeleteCommand = customerDeletes

参照

リファレンス

SyncAdapter クラス
SyncAdapter メンバー
Microsoft.Synchronization.Data.Server 名前空間