HypGetCalcScript

Data provider types: Oracle Essbase

Description

HypGetCalcScript() gets the calculation script string for a given calculation script.

Use with HypExecuteCalcScriptString.

This function requires Oracle Hyperion Provider Services 11.1.2.4.017 or higher.

Syntax

HypGetCalcScript (vtSheetName, vtCalcScriptName, vtType, vtCalcScriptOutput)

ByVal vtSheetName As Variant

ByVal vtCalcScriptName As Variant

ByVal vtType As Variant

ByRef vtCalcScriptOutput As Variant

Parameters

vtSheetName: Input parameter; the name of worksheet on which to run the function. If vtSheetName is Null or Empty, the active worksheet is used, and the data source of the given sheet name will be used for connection.

vtCalcScriptName: Input parameter; the name of the calculation script for which the output is needed.

vtType: Input parameter; the type of calculation script file. Valid values are 1 or 2. Type 1 represents a csc file; type 2 represents a rep file. If input is incorrect, then treated as type 1.

vtCalcScriptOutput: Output parameter; the string which returns the calculation script string.

Return Value

Returns 0 if successful; otherwise, returns the appropriate error code.

Example

Sub calcScrVBATest()

Sts = HypGetCalcScript("Sheet1", "rule1", 1, Script)

Param = "_mySales=222;"

Sts = HypExecuteCalcScriptString("Sheet1", Script, Param)

End Sub