# EsbBeginDataload

Description

EsbBeginDataload() starts sending an update specification to the active database, and can unlock any data blocks locked for update. The update data can either be stored in the database, or just verified and any errors returned.

Syntax

    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

Parameters

hCtx | Essbase API context handle.
Store | Controls storage of data. If TRUE, data is stored in the server; if FALSE, no data is stored.
Unlock | Controls unlocking of data blocks. If TRUE, all relevant blocks which are locked will be unlocked (after data is stored, if necessary). If FALSE, no blocks are unlocked.
abortOnError | If TRUE, data load stops on the first error. Otherwise, data load continues.
pRules | Pointer to the rules file object definition structure.

Return Value

None.

Notes

- EsbBeginDataload() must be followed by at least one call to EsbSendString() to send the update specification, and then a call to EsbEndDataload().
- Each string passed to EsbSendString() following EsbBeginDataload() must be terminated with a carriage return/linefeed character sequence ("\r\n").
- If both the Store and Unlock flags are set to FALSE, the database merely performs a syntax check of the update specification.
- Unlike EsbBeginUpdate(), which ignores input rows (records) after an improper input row, EsbBeginDataload() processes the remaining input rows, and commits them if appropriate.

Access

EsbBeginDataload() requires the caller to have write privilege (ESS_PRIV_WRITE) to the active database.

Example

See Also