EsbGetLogFile

Description

EsbGetLogFile() copies all or part of an application log file from the server to the client.

Syntax
EsbGetLogFile (hCtx, AppName, TimeStamp, LocalName)
ByVal hCtx      As Long
ByVal AppName   As String
ByVal TimeStamp As Long
ByVal LocalName As String,

Parameters

hCtxEssbase VB API context handle
AppNameApplication name. If AppName = " ", the Essbase.log is returned.
TimeStampTime stamp, indicating date & time of earliest log file entry required
LocalNameFull path name of local destination file on client

Return Value

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

Notes

Access

This function requires the caller to have Application Design privilege (ESB_PRIV_APPDESIGN), or Database Design privilege (ESB_PRIV_DBDESIGN) for the specified application or any of its databases.

Example

Declare Function EsbGetLogFile Lib "ESBAPIW" (ByVal hCtx As Long, ByVal AppName As String, ByVal TimeStamp As Long, ByVal LocalName As String) As Long

Sub ESB_GetLogFile ()
   Dim sts As Long
   Dim AppName As String
   Dim TimeStamp As Long
   Dim LocalName As String

   AppName = "Sample"

   '***************
   ' Get everything
   '***************
   TimeStamp = 0

   LocalName = "c:\essbase\client\test.log"

   '*************
   ' Get Log File
   '************* 

   sts = EsbGetLogFile (hCtx, AppName, TimeStamp,
   LocalName)
End Sub

See Also

EsbDeleteLogFile()