HypSetGlobalOption

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

Description

HypSetGlobalOption() sets global Smart View options. Global options are options that apply to the entire current workbook and to any workbooks and worksheets that are created henceforth.

Note:

You can set only one option at a time.

See also HypSetOption.

Syntax

HypSetGlobalOption(vtItem, vtGlobalOption)

ByVal vtItem As Long

ByVal vtGlobalOption As Variant

Parameters

vtItem: The number that indicates which option is to be set. See Table 4, HypGetGlobalOption Parameter Numbers and Options for values.

vtGlobalOption: A variant which can take a Boolean, Number, or Text value denoting the option being set for vtItem. If Null or Empty, no action is performed.

Return Value

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

Example

The following example sets the option to display no messages.

Declare Function HypSetGlobalOption Lib "HsAddin" (ByVal vtItem As Long, ByVal vtGlobalOption As Variant) As Long

Sub Example_HypSetGlobalOption()
   X=HypSetGlobalOption(5, 3)
If X=0 Then
   MsgBox("Message level is set to 3 - No messages")
Else
   MsgBox("Error. Message level not set.")
End If
End Sub