HypListCalcScriptsEx

Data Sources: Essbase, Planning

Description

HypListCalcScriptsEx() lists all business rules.

Note:

See Usage under HypExecuteCalcScriptsEx for more information and example.

Syntax

HypListCalcScriptsEx (vtSheetName [in], vtbRuleOnForm [in], pvtArCubeNames [out], pvtArBRNames [out], pvtArBRTypes [out], pvtArBRHasPrompts [out], pvtArBRNeedPageInfo [out], pvtArBRHidePrompts [out])

ByVal vtSheetName As Variant

ByVal vtbRuleOnForm As Variant

ByRef vtCubeNames As Variant

ByRef vtBRNames As Variant

ByRef vtBRTypes As Variant

ByRef vtBRHasPrompts As Variant

ByRef vtBRNeedsPageInfo As Variant

ByRef vtBRHidePrompts As Variant

Parameters

vtSheetName: For future use. Currently the active sheet is used.

vtbRuleOnForm: Boolean to indicate whether the user wants to list business rules associated only with the form opened on the sheet. If this argument is false, all the business rules associated with the application will be returned.

pvtArCubeNames: Array of cube names (Plan Types in Planning) associated with the Business rules

pvtArBRNames: Array of Business Rule Names

pvtArBRTypes: Array of Business Rule Types

pvtArBRHasPrompts: – Array of booleans indicating whether the Business Rule has Run Time Prompts

pvtArBRNeedPageInfo: Array of booleans indicating whether the Business Rule needs Page Information on the sheet to be run

pvtArBRHidePrompts: Array of booleans indicating whether the RTPs for this Business Rule are hidden

Return Value

Returns SS_OK if successful; otherwise, the appropriate error code.