EssDeleteLogFile

Deletes an application log file or the Essbase Server log file (essbase.log) on the server.

Syntax

ESS_FUNC_M EssDeleteLogFile (hCtx, AppName);
ParameterData TypeDescription

hCtx

ESS_HCTX_T

API context handle.

AppName

ESS_STR_T

Application name or NULL. If NULL, EssDeleteLogFile deletes the Essbase Server log file (essbase.log).

Notes

Return Value

None.

Access

The caller must have Application Designer privilege (ESS_PRIV_APPDESIGN) for the specified application.

Example

ESS_FUNC_M
ESS_DeleteLogFile (ESS_HCTX_T  hCtx)
{
   ESS_FUNC_M        sts = ESS_STS_NOERR;
   ESS_STR_T        AppName;
   AppName = "Sample";
   
   sts = EssDeleteLogFile (hCtx, AppName);
   return(sts);
}
EssDeleteLogFile ("")  //Deletes Agent log file.

See Also