EssBeginDataload

Description

EssBeginDataload() 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

ESS_STS_T EssBeginDataload (hCtx, Store, Unlock, abortOnError, pRules);
ESS_HCTX_ThCtx;
ESS_BOOL_TStore;
ESS_BOOL_TUnlock;
ESS_BOOL_TabortOnError;
ESS_POBJDEF_TpRules;

Parameters

hCtxEssbase API context handle.
StoreControls storage of data. If TRUE, data is stored in the server; if FALSE, no data is stored.
UnlockControls 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.
abortOnErrorIf TRUE, data load stops on the first error. Otherwise, data load continues.
pRulesPointer to the rules file object definition structure.

Return Value

None.

Notes

Access

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

Example

ESS_STS_T     sts = ESS_STS_NOERR;
ESS_BOOL_T    Store;
ESS_BOOL_T    Unlock; 
ESS_STR_T     Query1, Query2;
ESS_PMBRERR_T pMbrErr;
   
   Store  = ESS_TRUE;
   Unlock = ESS_FALSE;
   Query1 = "Year Market Scenario Measures Product 12345";
   Query1 = " Jan  East  Scenario Measures Coke  125";
                  
   /* Begin Update */
   sts = EssBeginDataload (hCtx, Store, Unlock, ESS_FALSE, ESS_NULL);  
   
   /* Send update specification */
   if(!sts)
      sts = EssSendString(hCtx, Query1);
      sts = EssSendString(hCtx, Query2);
      
   /* End Update */
   if(!sts)
      sts = EssEndDataload(hCtx, &pMbrErr);

See Also

EssSendString()
EssEndDataload()
EssBeginUpdate()
EssEndUpdate()
EssUpdate()
EssImport()