# 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

hCtx | Essbase VB API context handle
AppName | Application name. If AppName = " ", the Essbase.log is returned.
TimeStamp | Time stamp, indicating date & time of earliest log file entry required
LocalName | Full path name of local destination file on client

Return Value

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

Notes

- The time represented by TimeStamp is the number of seconds elapsed since midnight (00:00:00) Greenwich Mean Time on January 1, 1970. Only log file entries which occurred after the date & time specified by TimeStamp will be copied to the client. If TimeStamp is set to 0 (zero), the entire log file will be copied.

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()