FireDAC.Comp.Client.TFDCustomUpdateObject.Apply
Delphi
procedure Apply(ARequest: TFDUpdateRequest; var AAction: TFDErrorAction; AOptions: TFDUpdateRowOptions); virtual; abstract;
C++
virtual void __fastcall Apply(Firedac::Stan::Option::TFDUpdateRequest ARequest, Firedac::Stan::Intf::TFDErrorAction &AAction, Firedac::Stan::Option::TFDUpdateRowOptions AOptions) = 0 ;
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
procedure function |
public | FireDAC.Comp.Client.pas FireDAC.Comp.Client.hpp |
FireDAC.Comp.Client | TFDCustomUpdateObject |
説明
DataSet 内の現在のレコードのレコード更新要求をデータベースに適用します。
Apply を呼び出すと、現在の DataSet レコードの変更内容をデータベースに適用できます。
標準の実装（TFDUpdateSQL）では、SQL 文のパラメータを設定し、その SQL 文を実行してレコードを更新します。ARequest は更新の種類を示します。TFDUpdateSQL の場合は、実行する SQL 文を指定します。適切な SQL 文が指定されない場合、FireDAC では、TFDAdaptedDataSet.UpdateObject が指定されない場合と同様に、デフォルトの SQL 文を生成します。
Apply は主として、OnUpdateRecord イベント ハンドラから更新文を手動で実行するためのものです。ARequest、AAction、AOptions の各引数値は、Apply メソッドの対応する引数に割り当てられる必要があります。 ARequest の取り得る値は以下のいずれかです。
|
値 |
意味 |
TFDUpdateSQL のプロパティ |
|---|---|---|
|
|
データベースにレコードを挿入します。 |
InsertSQL |
|
|
データベース内のレコードを更新します。 |
ModifySQL |
|
|
データベースからレコードを削除します。 |
DeleteSQL |
|
|
データベース内のレコードをロックします。 |
LockSQL |
|
|
データベース内のレコードに対するロックを解除します。 |
UnlockSQL |
|
|
データベースからレコードを取得します。 |
FetchRowSQL |
|
|
データベース内の Oracle BLOB/CLOB 値を更新します。 |
- |
|
|
レコードに挿入するジェネレータ値を取得します。 |
- |
AAction は Apply メソッドの完了ステータスを返し、呼び出し元のコードでどのような処置を取るべきかを指定します。通常、このステータスは FireDAC コードで使用されます。Apply メソッドが OnUpdateRecord イベント ハンドラから呼び出される場合は、イベント ハンドラの AAction 引数を Apply メソッドの AAction 引数に割り当てます。そうでない場合は、eaDefault を初期値として使用します。
AOptions は追加オプションを指定します。Apply メソッドが OnUpdateRecord イベント ハンドラから呼び出される場合は、イベント ハンドラの AOptions 引数を Apply メソッドの AOptions 引数に割り当てます。そうでない場合は、[] を値として使用します。