EssVSetGlobalOption

Description

Sets individual workspace options.

Note:

This function is not plural because you can set only one option.

Syntax

EssVSetGlobalOption(item, globalOption)
ByVal item As Long
ByVal globalOption As Variant

Parameters

item

Number indicating which option is to be set. item cannot be Null or Empty. Table 15 indicates which options are set for which number and the expected data type:

Table 15. Item Number Options and Expected Data Types

itemOptionExpected Data Type

1

Enable secondary button setting

Boolean

2

Enable double-clicking setting

Boolean

3

Enable FlashBack setting

Boolean

4

This setting is maintained for backward compatibility with previous Essbase releases.

Boolean

5

Specify message level setting

Number

 

1 Info, Warning & Error messages

 
 

2 Warning & Error messages only

 
 

3 Error Messages only

 
 

4 No messages

 

6

Enable display unknown messages setting

Boolean

7

Enable route messages to log setting

Boolean

8

Enable purge log setting

Boolean

9

Enable double-clicking to browse Linked Report Objects setting

Boolean

10

Display Member Select Save dialog box setting

Boolean

11

Enable Navigate Without Data

Boolean

globalOption

A Boolean or Number value denoting the option being set for item. If globalOption is Null or Empty, the active worksheet value for the item is used.

Return Value

Returns 0 if successful. A negative number indicates a local failure (see VBA Return Values). A return value greater than zero indicates a failure on the server.

Example

This example sets the option to display error messages only.

Declare Function EssVSetGlobalOption Lib "ESSEXCLN.XLL" (ByVal item As Long, ByVal globalOption As Variant) As Long

Sub SetGlobal()
X=EssVSetGlobalOption(5, 3)
If X=0 Then
   MsgBox("Message level is set to 3 - Errors only")
Else
   MsgBox("Error. Message level not set.")
End If
End Sub

Notes: