EssCalcFile

Description

EssCalcFile() executes a calc script against the active database from a file.

Syntax

ESS_FUNC_M EssCalcFile (hDestCtx, hSrcCtx, AppName, DbName,
FileName, Calculate);
ESS_HCTX_ThDestCtx
ESS_HCTX_ThSrcCtx
ESS_STR_TAppName
ESS_STR_TDbName
ESS_STR_TFileName
ESS_BOOL_TCalculate

Parameters

hDestCtxEssbase API context handle of target database on the server.
HSrcCtxEssbase API context handle for calc script file location. The calc script file can reside on the client or on the same server as the target database.
AppNameApplication name for calc script file location.
DbNamedatabasename for calc script file location.
FileNameName of calc script file.
CalculateControls calculation of the calc script. If TRUE, the calc script is executed.

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_CalcFile (ESS_HCTX_T  hCtx)
{
   ESS_FUNC_M      sts = ESS_STS_NOERR;
   ESS_SHORT_T    isResponse;
   ESS_HCTX_T   hSrcCtx;
   ESS_BOOL_T   isObject = ESS_FALSE; 
   ESS_STR_T    AppName;
   ESS_STR_T    DbName;
   ESS_STR_T    FileName;
   ESS_PROCSTATE_T pState;
   
   hSrcCtx  = hCtx;
   AppName  = "Sample";
   DbName   = "Basic";
   FileName = "Test"; 
   
   sts = EssCalcFile (hCtx, hSrcCtx, AppName, 
         DbName, FileName, ESS_TRUE);
   if (!sts)
   {
      sts = EssGetProcessState (hCtx, &pState);
      while (!sts || (pState.State != 
              ESS_STATE_DONE))
         sts = EssGetProcessState (hCtx, &pState);
   }
   return(sts);
}

See Also

EssBeginCalc()
EssCalc()
EssDefaultCalc()
EssSetDefaultCalcFile()