EssWriteToLogFile

Writes a message to the Essbase Server log file (essbase.log), or to the application log file (appname.log).

Syntax

ESS_FUNC_M  EssWriteToLogFile (hCtx, AgentLog, Message);

Parameter	Data Type	Description
hCtx	ESS_HCTX_T	API context handle.
AgentLog	ESS_BOOL_T	If TRUE, message is written to the Essbase Server log file, essbase.log. If FALSE, message is written to the application log file, appname.log.
Message	ESS_STR_T	Message to be logged to the Essbase Server log file (essbase.log), or to the application log file (appname.log).

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

The caller must have supervisor privilege (ESS_ACCESS_SUPER) for the specified application.

Example

ESS_FUNC_M ESS_WriteToLogFile (ESS_HCTX_T hCtx)
{
   ESS_STR_T     Message = NULL;
   ESS_FUNC_M     sts = ESS_STS_NOERR;                                 
   
   Message = "Received login request";
         
   /* 
    * Writes the message (Received login request) to the Agent log file.
    */
   sts = EssWriteToLogFile(hCtx, ESS_TRUE, Message);
   return(sts);
}