Data.Win.ADODB.TCustomADODataSet.CancelBatch
Delphi
procedure CancelBatch(AffectRecords: TAffectRecords = arAll);
C++
void __fastcall CancelBatch(TAffectRecords AffectRecords = (TAffectRecords)(0x2));
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
procedure function |
public | Data.Win.ADODB.pas Data.Win.ADODB.hpp |
Data.Win.ADODB | TCustomADODataSet |
説明
保留中のバッチ更新をキャンセルします。
CancelBatch を呼び出すと、バッチ更新モードで開かれたデータセット内の、保留中の更新をキャンセルすることができます。CancelBatch は、保留中の更新がないときにはエラーなく呼び出せますが、何らかの効果もありません。
CancelBatch は、即時更新モードのデータセットには適用できません。CancelBatch を、そのようなデータセットに対して、arCurrent 定数なしに呼び出すと、例外が発生します。
デフォルトの AffectsRecords パラメータ値は arAll です。
AffectRecords パラメータは、 次の TAffectRecords 値のいずれかになります：
| オプション | 意味 |
|---|---|
|
arCurrent |
現在の行の更新のみ適用。 |
|
arFiltered |
現在のフィルタに一致する行の更新のみ適用。 |
|
arAll |
すべての行の更新を適用。 |
|
arAllChapters |
すべてのチャプター（ADO チャプター）に更新を適用。 |
メモ： バッチ更新を使用するには、データセット コンポーネントの CursorType プロパティが ctKeySet（デフォルト）または ctStatic に、LockType プロパティが ltBatchOptimistic になっていなければなりません。