EssBeginCalc

Description

EssBeginCalc() starts sending a calc script and optionally executes it against the active database.

Syntax

ESS_FUNC_M EssBeginCalc (hCtx, Calculate);
ESS_HCTX_ThCtx
ESS_BOOL_TCalculate

Parameters

hCtxEssbase API context handle.
CalculateControls calculation of the calc script. If TRUE, the calc script is executed.
CalcScriptThe calc script, as a single string (must be less than 64 Kbytes).

Return Value

None.

Notes

Access

This function requires the caller to have calc privilege (ESS_PRIV_CALC) to the active database.

Example

ESS_FUNC_M
ESS_Calc   (ESS_HCTX_T         hCtx)
{
   ESS_FUNC_M         sts = ESS_STS_NOERR;
   ESS_STR_T         Script;
   ESS_PROCSTATE_T   pState; 
   Script = "CALC ALL;";
            
   sts = EssBeginCalc (hCtx,ESS_TRUE);
   if (!sts)
      sts = EssSendString (hCtx, Script);
   if (!sts)
      sts = EssEndCalc (hCtx);
   if (!sts)
   {
      sts = EssGetProcessState (hCtx, &pState);
      while(!sts || (pState.State != 
             ESS_STATE_DONE))
         sts = EssGetProcessState (hCtx, &pState);   
   }
   return(sts);
}

See Also

EssCalc()
EssCalcFile()
EssDefaultCalc()
EssEndCalc()
EssGetDefaultCalc()
EssGetProcessState()
EssSendString()
EssSetDefaultCalc()