アクティブ・データベースに更新指定の送信を開始し、更新用にロックされたデータ・ブロックのロックを解除できます。更新データはデータベースに保管することも、確認のみ行ってエラーがあれば戻すこともできます。
構文
Declare Function EsbBeginDataload Lib "esbapin" (
ByVal hCtx As Long,
ByVal isStore As Integer,
ByVal isUnlock As Integer,
ByVal isAbortOnError As Integer,
pRules As ESB_OBJDEF_T) As Long
| パラメータ | 説明 |
|---|---|
hCtx |
APIコンテキスト・ハンドル。 |
Store |
データの保管を制御します。TRUEの場合は、データがサーバーに保管されます。FALSEの場合はデータは保管されません。 |
Unlock |
データ・ブロックのロック解除を制御します。TRUEの場合、ロックされているすべての関連ブロックのロックが解除されます(必要に応じてデータの保管後)。FALSEの場合、ブロックのロックは解除されません。 |
abortOnError |
TRUEの場合、最初のエラーでデータ・ロードが停止します。それ以外の場合は、データ・ロードを続行します。 |
pRules |
ルール・ファイル・オブジェクト定義構造体へのポインタ。 |
備考
EsbBeginDataload()を呼び出した後、EsbSendString()を1回以上呼び出して更新指定を送信し、最後にEsbEndDataload()を呼び出す必要があります。
EsbBeginDataload()の後に呼び出したEsbSendString()へ渡される各文字列の末尾は、改行復帰文字シーケンス("\r\n")であることが必要です。
StoreおよびUnlockの両方のフラグがFALSEに設定されている場合、データベースは更新指定の構文確認のみを行います。
誤った入力行以降の入力行(レコード)を無視するEsbBeginUpdate()とは異なり、EsbBeginDataload()は残りの入力行も処理し、必要に応じてコミットします。
戻り値
なし。
アクセス
EsbBeginDataload()は、呼出し元がアクティブなデータベースに対する書込み権限(ESS_PRIV_WRITE)を持っていることを必要とします。