# EsbEndDataload

Description

EsbEndDataload() marks the end of an update specification being sent to the active database, and must be called after sending the update specification using EsbSendString().

Syntax

    Declare Function EsbEndDataload Lib "esbapin" (
    ByVal hCtx As Long,
    ByVal ErrorName As String) As Long

Parameters

hCtx | Essbase API context handle.
ErrorName | The name of the text file containing the list of errors. Possible errors (and error strings) in the text file are: ESS_MBRERR_UNKNOWN (Unknown member [membername] in dataload, [number] records returned.) ESS_MBRERR_DBACCESS (You have insufficient access privilege to perform a lock on this database.) ESS_MBRERR_BADDATA (Invalid member [membername] in data column.) ESS_MBRERR_DUPLICATE (Duplicate members from the same dimension on data record, [number] records completed.) AD_MSGDL_ERRORLOAD (Unable to do dataload at Item/Record [number].)

Return Value

Returns zero, if successful. Otherwise, returns an error code, as follows:

- If abortOnError is TRUE:
  - The error code for the first error condition is returned.
  - The error list is NULL.
- If abortOnError is FALSE:
  - An error file is returned, if the server can process the data and can continue.
  - Otherwise, in exceptional circumstances, the error code explaining why the server cannot continue is returned. For example:
    AD_MSGDL_COLS (too many data values in a record)
    AD_MSGDL_MISDIM (data value encountered before all dimensions selected)

Notes

- EsbEndDataload() must be preceded by a call to EsbBeginDataload(), and at least one call to EsbSendString().
- EsbEndDataload() returns a text file containing the list of errors.

Access

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

Example

See Also