EssGetLogFile

Copies all or part of an application log file (appname.log) or the Essbase Server log file (essbase.log) from the server to the client.

Syntax

ESS_FUNC_M EssGetLogFile (hCtx, AppName, TimeStamp, LocalName};

Parameter	Data Type	Description
hCtx	ESS_HCTX_T	API context handle.
AppName	ESS_STR_T	Application name or NULL. If NULL, EssGetLogFile accesses the Essbase Server log file (essbase.log).
TimeStamp	ESS_TIME_T	Time stamp, indicating date and time of earliest log file entry required. If TimeStamp is set to 0 (zero), EssGetLogFile copies the entire log file.
LocalName	ESS_STR_T	Full path name of local destination file on client.

Notes

TimeStamp represents the number of seconds elapsed since midnight (00:00:00) Greenwich Mean Time on January 1, 1970. This function copies to the client only log file entries occurring after the date & time specified by TimeStamp.
For the locations of essbase.log and appname.log, see the Oracle Essbase Database Administrator's Guide.

Return Value

If successful, the file is copied to the local file specified by LocalName.

Access

This function requires the caller to have application Design privilege (ESS_PRIV_APPDESIGN), or database Design privilege (ESS_PRIV_DBDESIGN) for the specified application or any of its databases.

Example

ESS_FUNC_M 
ESS_GetLogFile (ESS_HCTX_T hCtx)
{
   ESS_FUNC_M     sts = ESS_STS_NOERR;
   ESS_STR_T     AppName;
   ESS_TIME_T    TimeStamp;
   ESS_STR_T     LocalName;                                 
   
   AppName   = "Sample";
   LocalName = "C:\\Hyperion\\products\\Essbase\\EssbaseServer\\test.log";
   
   /* Get entire log file */
   TimeStamp = 0;
   
   sts = EssGetLogFile(hCtx, AppName, TimeStamp,
         LocalName);
   return (sts);
}