EssVGetGlobalOption

Description

Returns information about individual Essbase workspace options.

Syntax

EssVGetGlobalOption(item)
ByVal item As Long

Parameters

item

Number indicating which option is to be retrieved. item cannot be Null or Empty. Table 8 indicates which options are returned for which number.

Table 8. Item Number Options and Return Types

ItemOptionReturn Data Type

1

Enable secondary button setting

Boolean

2

Enable double-clicking setting

Boolean

3

Enable FlashBack setting

Boolean

4

Enable retain member selection information setting

Note:

This setting is obsolete.

Boolean

5

Specify message level setting

1 Info, Warning & Error messages

2 Warning & Error messages only

3 Error Messages only

4 No messages

Number

6

Enable display unknown members setting

Boolean

7

Enable route messages to log setting

Boolean

8

Enable purge log setting

Boolean

9

Enable double-clicking to browse Linked Reporting Objects setting

Boolean

10

Display Member Select Save dialog box setting

Boolean

11

Enable Navigate Without Data

Boolean

Return Value

Returns a number or Boolean value indicating the state of the requested option. If an error occurs, #VALUE! is returned. If item is not between 1 and 10, #NUM! is returned.

Example

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

Declare Function EssVGetGlobalOption Lib "ESSEXCLN.XLL" (ByVal item As Long) As Variant

Sub GetGlobal()
Dim X As String
X=EssVGetGlobalOption(5)
If X="#NUM!" Then
MsgBox("Invalid item ID specified.")
Else
If X="#VALUE!" Then
MsgBox("Error. Option could not be found.")
Else
MsgBox("Message level is set to " + X)
End If
End If
End Sub