# EsbWriteToLogFile

Description

EsbWriteToLogFile() writes a message to the Agent log file (`ESSBASE.LOG`), or to the Server log file (`APPNAME.LOG`).

Syntax

    Declare Function EsbWriteToLogFile Lib "esbapin" (
    ByVal hCtx As Long,
    ByVal isAgentLog As Boolean,
    ByVal Message As String) As Long

Parameters

hCtx | Essbase API context handle.
isAgentLog | If TRUE, message is written to the Agent log file, `ESSBASE.LOG`. If FALSE, message is written to the Server log file, `APPNAME.LOG`.
Message | Message to be logged to the Agent log file (`ESSBASE.LOG`), or to the Server log file (`APPNAME.LOG`).

Return Value

Returns a zero if successful.

Notes

- The Agent log file (`ESSBASE.LOG`) and the Server log file (`APPNAME.LOG`) are located on the server in the ARBORPATH directory. Use EsbGetLogFile() to view message logs.

Access

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

Example

See Also