EssLogSize

Returns the size of the Essbase Server log file (essbase.log), or of the application log file (appname.log).

Syntax

ESS_FUNC_M EssLogSize (hCtx, AgentLog, pszAppName, pulLogSize);

Parameter	Data Type	Description
hCtx	ESS_HCTX_T	API context handle.
AgentLog	ESS_BOOL_T	If TRUE, the size of the Essbase Server log file (essbase.log) is returned. If FALSE, the size of the application log file (appname.log) is returned.
pszAppName	ESS_STR_T	Application name.
pulLogSize	ESS_PULONG_T	Size of log file returned.

Notes

Use EssGetLogFile() to view message logs.

For the locations of essbase.log and appname.log, see the Oracle Essbase Database Administrator's Guide.

Return Value

Returns a zero if successful.

Access

This function does not require the caller to have access privileges.

Example

ESS_FUNC_M ESS_LogSize (ESS_HCTX_T hCtx)
{
   ESS_STR_T     pszAppName = NULL;
   ESS_ULONG_T   ulLogSize = 0;
   ESS_FUNC_M     sts = ESS_STS_NOERR;                                 
   
   pszAppName = "Sample";
      
   /* 
    * Get the log file size for the "Sample" application.
    */
   sts = EssLogSize(hCtx, ESS_FALSE, pszAppName, &ulLogSize);
   
   return(sts);
}