HypGetSheetOption

データ・プロバイダ・タイプ: Essbase、Planning、Financial Management、Hyperion Enterprise

説明

HypGetSheetOption()は、シート・レベル・オプションに関する情報を戻します。

構文

HypGetSheetOption(vtSheetName, vtItem)

ByVal vtSheetName As Variant

ByVal vtItem As Variant

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブ・ワークシートが使用されます。

vtItem: 取得するオプションを示す番号。値のリストは、表5を参照してください。

表 5. vtItemのオプション

vtItem

オプション

データ型と値

1

ズーム・イン・レベルの設定:

  • 0 = 次のレベル

  • 1 = すべてのレベル

  • 2 = 最下位レベル

  • 3 = 兄弟レベル

  • 4 = 同一レベル

  • 5 = 同一世代

  • 6 = 式

数値

2

「選択を組み込む」の設定の使用可能化

ブール

3

選択したグループ内の設定を使用可能にします

ブール

4

「選択されていないグループの削除」の設定の使用可能化

ブール

5

インデント設定の指定:

  • 0 = インデントなし

  • 1 = サブ・アイテムのインデント

  • 2 = 合計のインデント

数値

6

欠落の抑制の設定の使用可能化

ブール

7

ゼロの抑制の設定の使用可能化

ブール

8

アンダースコアの抑制の設定の使用可能化

ブール

9

「アクセス権なし」の設定の使用可能化

ブール

10

重複したメンバーの設定の使用可能化

ブール

11

無効な設定の使用可能化

ブール

12

祖先の位置:

  • 0 = 最上位

  • 1 = 最下位

数値

13

「不足しているテキスト」のラベルの指定

テキスト

14

「アクセス権なし」のラベルの指定

テキスト

15

セル・ステータス:

  • 0 = データ

  • 1 = 計算ステータス

  • 2 = プロセス管理

数値

16

メンバー名の表示オプション:

  • 0 = 名前のみ

  • 1 = 名前と説明

  • 2 = 説明のみ

数値

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

      Declare Function HypGetSheetOption Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtItem As Variant) As Variant

Sub Example_HypGetSheetOption()
sts = HypGetSheetOption("Sheet", 5)
If sts = -15 then
   Msgbox ("Invalid Parameter")
Else
   Msgbox ("Indentation is set to" & sts)
End If
End Sub