HypGetOption

Data Source types: Essbase

Description

HypGetOption() enables you to get Smart View options that are both default and sheet specific so you do not need separate VBAs for the two types of options.

Syntax

HypGetOption (vtItem,vtRet,vtSheetName)

ByVal vtItem As Variant

ByRef vtRet As Variant

ByVal vtSheetName As Variant

Parameters

vtItem:The index/constant to refer to a particular option. See Table 18.

vtRet: The output variable

vtSheetName: The sheet name of a sheet level option. If not provided, then the default option is used.

Return Value

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

Example

Public Declare Function HypGetOption Lib "HsAddin" (ByVal vtItem As Variant, ByRef vtRet As Variant, ByVal vtSheetName As Variant) As Long

Sub getOption()

sts = HypGetOption(HSV_ZOOMIN, Var, "Sheet2") ‘get zoom in option for sheet2
sts = HypGetOption(1, Var, "") ‘get default zoom in option

End Sub

Table 18. Options Constants for HypGetOption and HypSetOption

Options Constants for HypGetOption and HypSetOption
HSV_ZOOMIN = 1
HSV_INCLUDE_SELECTION
HSV_WITHIN_SELECTEDGROUP
HSV_REMOVE_UNSELECTEDGROUP
HSV_INDENTATION
HSV_SUPPRESSROWS_MISSING
HSV_SUPPRESSROWS_ZEROS
HSV_SUPPRESSROWS_UNDERSCORE
HSV_SUPPRESSROWS_NOACCESS
HSV_SUPPRESSROWS_REPEATEDMEMBERS
HSV_SUPPRESSROWS_INVALID
HSV_ANCESTOR_POSITION
HSV_MISSING_LABEL
HSV_NOACCESS_LABEL
HSV_CELL_STATUS
HSV_MEMBER_DISPLAY
HSV_INVALID_LABEL
HSV_SUBMITZERO
HSV_19 Reserved for future use
HSV_20 Reserved for future use
HSV_PRESERVE_FORMULA_COMMENT
HSV_22 Reserved for future use
HSV_FORMULA_FILL
HSV_EXCEL_FORMATTING = 30
HSV_RETAIN_NUMERIC_FORMATTING
HSV_THOUSAND_SEPERATOR
HSV_NAVIGATE_WITHOUTDATA
HSV_ENABLE_FORMATSTRING
HSV_ENHANCED_COMMENT_HANDLING
HSV_ADJUSTCOLUMNWIDTH
HSV_DOUBLECLICK_FOR_ADHOC = 101
HSV_UNDO_ENABLE
HSV_103 Reserved for future use
HSV_LOGMESSAGE_DISPLAY
HSV_ROUTE_LOGMESSAGE_TO_FILE
HSV_CLEAR_LOG_ON_NEXTLAUNCH
HSV_REDUCE_EXCEL_FILESIZE
HSV_ENABLE_RIBBON_CONTEXT
HSV_DISPLAY_HOMEPANEL_ONSTARTUP
HSV_SHOW_COMMENTDIALOG_ON_REFRESH