# EssSetDefaultCalcFile

Description

EssSetDefaultCalcFile() sets the default calc script for the active database from a calc script file.

Syntax

    ESS_FUNC_M  EssSetDefaultCalcFile (hDestCtx, hSrcCtx, AppName, DbName, FileName);

ESS_HCTX_T | hDestCtx
ESS_HCTX_T | hSrcCtx
ESS_STR_T | AppName
ESS_STR_T | DbName
ESS_STR_T | FileName

Parameters

hDestCtx | Essbase API context handle of target database on the server.
hSrcCtx | Essbase 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.
AppName | Application name for calc script file location
DbName | Database name for calc script file location
FileName | Name of default calc script file

Return Value

None.

Notes

- The default calc script must not be greater than 64 Kbytes long.
- The server makes a copy of the text in the calc script file when this function is called. Subsequent changes to the calc script file have no effect on the default calc unless this function is called again to update it.

Access

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

Example

    ESS_FUNC_M
    ESS_SetDefaultCalcFile  (ESS_HCTX_T  hCtx)
    {
       ESS_FUNC_M    sts = ESS_STS_NOERR;
       ESS_HCTX_T   hSrcCtx;
       ESS_STR_T    AppName;
       ESS_STR_T    DbName;
       ESS_STR_T    FileName;
       AppName  = "Sample";
       DbName   = "Basic";
       FileName = "DefTest";
       hSrcCtx = hCtx;
       sts = EssSetDefaultCalcFile (hCtx, hSrcCtx,
             AppName, DbName, FileName);
       return(sts);
    }

See Also

EssDefaultCalc
EssGetDefaultCalc()
EssSetDefaultCalc()