EssUpdate

Sends an update specification to the active database as a single string.

Syntax

ESS_FUNC_M  EssUpdate (hCtx, Store, Unlock, UpdtSpec);

Parameter	Data Type	Description
hCtx	ESS_HCTX_T	API context handle.
Store	ESS_BOOL_T	Controls storage of data. If TRUE, data is stored in the server; if FALSE, no data is stored.
Unlock	ESS_BOOL_T	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.
UpdtSpec	ESS_STR_T	The update specification, as a single string (must be less than 32 KB).

Notes

This function is equivalent to making a call to EssBeginUpdate(), followed by calls to EssSendString() and finally EssEndUpdate(). The update data can either be stored in the database, or just verified and any errors returned. Also, any data blocks locked for update can be unlocked by this call.
The update specification string must be less than 32 KB long.
If this function causes data to be stored (Store flag is TRUE), the relevant data blocks must previously have been locked for update (for example, by calling EssReport() with the Lock flag set to TRUE).
If the caller attempts to write data to a member it does not have permission to write to, a warning is generated, and the member is not updated.
If both the Store and Unlock flags are set to FALSE, the database merely performs a syntax check of the update specification.

Return Value

None.

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);
}