HypZoomIn

Data provider types: Oracle Essbase, Oracle Hyperion Planning (ad hoc only), Oracle Planning and Budgeting Cloud (ad hoc only), Oracle Hyperion Financial Management (ad hoc only)

Description

HypZoomIn() retrieves and expands data from Oracle Smart View for Office based on the selected members.

Syntax

HypZoomIn(vtSheetName, vtSelection, vtLevel, vtAcross)

ByVal vtSheetName As Variant

ByVal vtSelection As Variant

ByVal vtLevel As Variant

ByVal vtAcross As Variant (not used)

Parameters

vtSheetName: The name of worksheet on which to run the function. If vtSheetName is Null or Empty, the active worksheet is used.

vtSelection: The range object that refers to the members to be zoomed in on. If the selection is Null or Empty, the active cell is used.

vtLevel: The number that indicates the level of the zoom. Available levels:

  • 0 = Next level

  • 1 = All levels

  • 2 = Bottom level

  • 3 = Siblings (available only for Essbase 11.1.2.1.102 or later connections using Oracle Hyperion Provider Services)

  • 4 = Same Level (available only for Essbase 11.1.2.1.102 or later connections using Provider Services)

  • 5 = Same generation (available only for Essbase 11.1.2.1.102 or later connections using Provider Services)

  • 6 = Formulas (available only for Essbase 11.1.2.1.102 or later connections using Provider Services)

If Null, Empty or an incorrect value is passed, the currently selected option is used.

vtAcross: Not used.

Return Value

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

Example

Declare Function HypZoomIn Lib "HsAddin" (ByVal vtSheetName As Variant,  ByVal vtSelection As Variant, ByVal vtLevel As Variant, ByVal vtAcross As Variant) As Long

Sub Example_HypZoomIn()
X=HypZoomIn(Empty, RANGE("B3"), 1, FALSE)
If X = 0 Then
   MsgBox("Zoom successful.")
Else
   MsgBox("Zoom failed.")
End If
End Sub