# EsbEndCalc

Description

EsbEndCalc() marks the end of a calc script being sent to the active database. This function must be called after sending the calc script (using EsbSendString()).

Syntax

    EsbEndCalc (hCtx)

    ByVal hCtx As Long

Parameters

hCtx | Essbase VB API context handle.

Return Value

None.

Notes

- This function must be preceded by a call to EsbBeginCalc(), and at least one call to EsbSendString().
- If the calls to EsbBeginCalc(), EsbSendString(), and EsbEndCalc succeed, the caller must call EsbGetProcessState() until it returns ESB_STATE_DONE to determine when the process has completed.

Access

This function requires the caller to have calc privilege (ESB_PRIV_CALC) to the active database.

Example

    Declare Function EsbEndCalc Lib "ESBAPIW" (ByVal hCtx As Long) As Long
    See the example for EsbBeginCalc().

See Also

EsbBeginCalc()
EsbCalc()
EsbSendString()