EssDeleteLogFile
Description
EssDeleteLogFile() deletes an application log file or the
Agent log file (ESSBASE.LOG) on the server.
Syntax
ESS_FUNC_M EssDeleteLogFile (hCtx, AppName);
ESS_HCTX_T | hCtx |
ESS_STR_T | AppName |
Parameters
hCtx | Essbase API context handle. |
AppName | Application name or NULL. If NULL, EssDeleteLogFile deletes the Agent log file (ESSBASE.LOG).
|
Return
Value
None.
Notes
- ESSBASE.LOG, the Agent message log, is located on the server
in the ARBORPATH directory. Use EssGetLogFile() to view
message logs.
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
EssGetLogFile()
EssLogSize()
EssWriteToLogFile()