HypSetGlobalOption

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

Description

HypSetGlobalOption() sets individual workspace options. For option descriptions, see Smart View Options.

Note:

You can set only one option at a time.

Syntax

HypSetGlobalOption(vtItem, vtGlobalOption)

ByVal vtItem As Long

ByVal vtGlobalOption As Variant

Parameters

vtItem: Number indicating which option is to be retrieved. See Table 16, HypGetGlobalOption Parameter Numbers and Options for values.

vtGlobalOption: A Boolean or Number value denoting the option being set for vtItem. If vtGlobalOption is 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 error messages only.

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

Sub SetGlobal()
   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