HypGetGlobalOption

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

Description

HypGetGlobalOption() returns information about individual Smart View workspace options.

Note:

For option descriptions, see Smart View Global Options.

Syntax

HypGetGlobalOption(vtItem)

ByVal vtItem As Long

Parameters

vtItem: Number that indicates which option is to be retrieved.

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

Table 15. HypGetGlobalOption Parameter Numbers and Options

vtItem	Option	Return Data Type
1	Enable Excel formatting	Boolean
2	Enable double-click for ad hoc operations	Boolean
3	Enable undo	Boolean
4	Not used	Boolean
5	Specify message level setting: 0 Information messages 1 Warning messages 2 Error messages 3 No messages	Number
6	Use thousands separator	Boolean
7	Enable route messages to log file	Boolean
8	Clear log file on next launch	Boolean
9	Enable navigate without data	Boolean
10	Display Member Selection save	Boolean
11	Enable double-clicking to browse LRO	Boolean
12	Specify Meaningless label	Text
13	Reduce Excel file size	Boolean
14	Enable formatted strings	Boolean
15	Retain numeric formatting	Boolean
16	Enable enhanced comment handling	Boolean
17	Enable retain ribbon context	Boolean
18	Display Smart View Panel on start-up	Boolean

Return Value

Returns a number or Boolean value indicating the state of the requested option. Returns an error code if parameter item is out of range.

Example

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

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

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