HypSetSheetOption

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

Description

HypSetSheetOption() sets individual spreadsheet options.

Note:

You can set only one option at a time (this function is not plural).

Syntax

HypSetSheetOption(vtSheetName, vtItem, vtOption)

ByVal vtSheetName As Variant

ByVal vtItem As Variant

ByVal vtOption As Variant

Parameters

vtSheetName: For future use. Currently the active sheet is used.

vtItem: Number indicating which option is to be set. See Table 19, Options for vtItem for a list of values.

vtOption: A Boolean value denoting the new value of item.

Table 19, Options for vtItem indicates which options are set for which number and the expected data type.

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 SetSheet()
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