HypExecuteCalcScript
Cloud data provider types: Oracle Analytics Cloud - Essbase
On-premises data provider types: Oracle Essbase
Description
HypExecuteCalcScript() uses a calculation script (business rule script) to initiate a calculation on the server.
Syntax
HypExecuteCalcScript (vtSheetName, vtCalcScript, vtSynchronous)
ByVal vtSheetName As Variant
ByVal vtCalcScript As Variant
ByVal vtSynchronous As Variant
Parameters
vtSheetName: The name of worksheet on which to run the function. If vtSheetName is Null
or Empty
, the active worksheet is used.
vtCalcScript: The name of the calculation script on the server in the database directory to run. To run the default calculation script, use Default
.
vtSynchronous: Not used
Return Value
Returns 0 if successful; otherwise, returns the appropriate error code.
Example
Declare Function HypExecuteCalcScript Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtCalcScript As Variant, ByVal vtSynchronous As Variant) As Long
Sub Example_HypExecuteCalcScript()
X = HypExecuteCalcScript (Empty, "Default", False)
If X = 0 Then
MsgBox("Calculation complete.")
Else
MsgBox("Calculation failed.")
End If
End Sub