EsbUpdate

Description

EsbUpdate() sends an update specification to the active database as a single string.

Syntax
EsbUpdate (hCtx, isStore, isUnlock, updQuery)
ByVal hCtx     As Long
ByVal isStore  As Integer
ByVal isUnlock As Integer
ByVal updQuery As String

Parameters

hCtxEssbase VB API context handle.
isStoreControls storage of data. If TRUE, data is stored in the server; if FALSE, no data is stored.
isUnlockControls unlocking of data blocks. If TRUE, all relevant blocks which are locked will be unlocked (after data is stored, if necessary). If FALSE, no blocks are unlocked.
updQueryThe update specification, as a single string (must be less than 64 KBytes).

Return Value

None.

Notes

Access

This function requires the caller to have write privilege (ESB_PRIV_WRITE) to the active database.

Example

Declare Function EsbUpdate Lib "ESBAPIW" (ByVal hCtx As Long, ByVal Store As Integer, ByVal Unlock As Integer, ByVal Query As String) As Long

Sub ESB_Update ()
   Dim sts As Long
   Dim Store As Integer
   Dim pUnlock As Integer 
   Dim Query As String 

   Query = "Year Market Scenario AcItemss Product 12345" 

   Store = ESB_YES
   pUnlock = ESB_NO

   '*******
   ' Update 
   '*******
   sts = EsbUpdate (hCtx, Store, pUnlock, Query) 
End Sub 

See Also

EsbBeginUpdate()
EsbEndUpdate()
EsbReport()
EsbSendString()
EsbUpdateFile()