EsbBeginReport

Description

EsbBeginReport() starts sending a report specification to the active database. This call must be followed by successive calls to EsbSendString to send the report specification, and finally by a call to EsbEndReport. The report data can either be output, or the report specification can just be verified and any errors returned. Also, the corresponding data blocks in the database can optionally be locked by this call (lock for update).

Syntax
EsbBeginReport (hCtx, isOutput, isLock)
ByVal hCtx     As Long
ByVal isOutput As Integer
ByVal isLock   As Integer

Parameters

hCtxEssbase VB API context handle.
isOutputControls output of data. If TRUE, data is output from the server, according to the specified report. If FALSE, no data is output.
isLockControls block locking. If TRUE, all blocks which are accessed by the report specification are locked for update. If FALSE, no blocks are locked.

Return Value

None.

Notes

Access

This function requires the caller to have read privilege (ESB_PRIV_READ) to one or more members in the active database.

Example

Declare Function EsbBeginReport Lib "ESBAPIW" (ByVal hCtx As Long, ByVal Output As Integer, ByVal Lock As Integer) As LongSub ESB_BeginReport ()
   Dim sts As Long
   Dim pOutput As Integer
   Dim pLock As Integer 
   Dim Query As String 
   Dim RString as String * 256
   Const szRString = 256
   Query = "<Desc Year !" 
   Output = ESB_YES
   Lock = ESB_NO
   '*************
   ' Begin Report 
   '*************
   sts = EsbBeginReport (hCtx, pOutput, pLock)

   '**************************
   ' Send report specification
   '**************************
   sts = EsbSendString (hCtx, Query)
   '***********
   ' End Report
   '*********** 
   sts = EsbEndReport (hCtx)
   '**********************
   ' Print out all strings
   '**********************
   If sts = 0 Then
      sts = EsbGetString (hCtx, RString, szRString) 
            Do While Mid$(RString, 1, 1) <> Chr$(0) 
               Print RString 
               sts = EsbGetString (hCtx, RString, szRString)
            Loop 
   End If 
End Sub 

See Also

EsbBeginUpdate()
EsbEndReport()
EsbGetString()
EsbReport()
EsbReportFile()
EsbSendString()