EssUpdate

Description

EssUpdate() sends an update specification to the active database as a single string.

Syntax

ESS_FUNC_M  EssUpdate (hCtx, Store, Unlock, UpdtSpec);
ESS_HCTX_ThCtx
ESS_BOOL_TStore
ESS_BOOL_TUnlock
ESS_STR_TUpdtSpec

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.
UpdtSpecThe update specification, as a single string (must be less than 64 Kbytes).

Return Value

None.

Notes

Access

This function requires the caller to have write privilege (ESS_PRIV_WRITE) to the active database. If the caller attempts to write information.

Example

ESS_FUNC_M
ESS_Update (ESS_HCTX_T   hCtx)
{
   ESS_FUNC_M       sts = ESS_STS_NOERR;
   
   sts = EssUpdate (hCtx, ESS_TRUE, ESS_FALSE,
       "Year Market Scenario Measures Product 100");
   return(sts);
}

See Also

EssBeginUpdate()
EssEndUpdate()
EssReport()
EssSendString()
EssUpdateFile()