HypSetSheetOption

Data provider types: Oracle Essbase, Oracle Hyperion Planning, Oracle Planning and Budgeting Cloud, Oracle Hyperion Financial Management

Description

HypSetSheetOption() sets sheet level options.

Note:

You can set only one option at a time.

Tip:

Use HypSetOption to set both global (default) and sheet specific Oracle Smart View for Office options so that you do not need separate VBA commands for the two option types.

Syntax

HypSetSheetOption(vtSheetName, vtItem, vtOption)

ByVal vtSheetName As Variant

ByVal vtItem As Variant

ByVal vtOption As Variant

Parameters

vtSheetName: The name of worksheet on which to run the function. If vtSheetName is Null or Empty, the active worksheet is used.

vtItem: The number that indicates which option is to be set. See Table 13-2 for a list of values.

vtOption: The new value of the item.

Return Values

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

Example

Declare Function HypSetSheetOption Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtItem As Variant, ByVal vtOption As Variant) As Long

Sub Example_HypSetSheetOption()
X=HypSetSheetOption(Empty, 6, FALSE)
If X=0 Then
   MsgBox("#Missing values will appear. ")
Else
   MsgBox("Error. #Missing option not set.")
End If
End Sub