HypGetGlobalOption

Data provider types: Essbase, Planning, Financial Management, Hyperion Enterprise

Description

HypGetGlobalOption() returns information about Smart View global options. Global options are options that apply to the entire current workbook and to any workbooks and worksheets that are created henceforth.

See also HypGetOption.

Syntax

HypGetGlobalOption(vtItem)

ByVal vtItem As Long

Parameters

vtItem: The number that indicates which option is to be retrieved

Table 4 lists the numbers of options and their return data types.

Table 4. HypGetGlobalOption Parameter Numbers and Options

vtItemOptionReturn Data Type
1Use Excel formattingBoolean
2Use double-click for ad hoc operationsBoolean
3Enable undoBoolean
4Not used--
5Specify message level setting:
  • 0 = Information

  • 1 = Warnings

  • 2 = Errors

  • 3 = None

  • 4 = Extended info

  • 5 = Profile

Integer
6Use thousands separatorBoolean
7Route messages to log fileBoolean
8Clear log file on next launchBoolean
9Navigate without dataBoolean
10Not used--
11Not used--
12Specify Meaningless labelText
13Reduce Excel file sizeBoolean
14Enable formatted stringsBoolean
15Retain numeric formattingBoolean
16Enable enhanced comment handlingBoolean
17Enable retain ribbon contextBoolean
18Display Smart View Panel on startupBoolean
19Always show on refresh (in Comment Edit dialog box; available only if Enhanced comment handling is enabled and the grid contains comments)Boolean

Return Value

Returns the appropriate return data type as shown in Table 4, HypGetGlobalOption Parameter Numbers and Options; otherwise, returns the appropriate error code.

Example

The following example sets the message level option and checks whether the value set is valid.

Declare Function HypGetGlobalOption Lib "HsAddin" (ByVal vtItem As Long) As Variant

Sub Example_HypGetGlobalOption()
   sts = HypGetGlobalOption(5)
   If sts = -15 then
      Msgbox ("Invalid Parameter")
   Else
      Msgbox ("Message level is set to" & sts)
	End If
End Sub