EssLogSize

Description

EssLogSize() returns the size of the Agent log file (ESSBASE.LOG), or of the Server log file (APPNAME.LOG).

Syntax
ESS_FUNC_M EssLogSize (hCtx, AgentLog, pszAppName, pulLogSize);
ESS_HCTX_ThCtx
ESS_BOOL_TAgentLog
ESS_STR_TpszAppName
ESS_PULONG_TpulLogSize

Parameters

hCtx Essbase API context handle.
AgentLog If TRUE, the size of the Agent log file (ESSBASE.LOG) is returned. If FALSE, the size of the Server log file (APPNAME.LOG) is returned.
pszAppName Application name.
pulLogSize Size of log file returned.

Return Value

Returns a zero if successful.

Notes

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);
}

See Also

EssDeleteLogFile()
EssGetLogFile()
EssWriteToLogFile()