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