HypRetrieveRange

データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning (アド・ホックのみ)、Oracle Planning and Budgeting Cloud (アド・ホックのみ)、Oracle Hyperion Financial Management (アド・ホックのみ)

説明

HypRetrieveRange()を使用すると、グリッド内またはワークシート内の選択したセル範囲または名前付きセル範囲をリフレッシュできます。選択したセル範囲または名前付きセル範囲は、有効なグリッド・レイアウトの形式にする必要があります。この関数で指定した範囲に、実際のグリッドに存在するより多くの行または列が含まれる場合、追加の行や列がコメントとして扱われ、グリッドの一部になります。

HypRetrieveRangeにより、「元に戻す」のバッファがクリアされるため、それ以降は「元に戻す」操作を使用できません。

Essbaseのみ: 複数グリッド・シートをリフレッシュまたは作成するには、HypCreateRangeGridを使用します。リリース11.1.2.5.610以降、HypRetrieveRange VBA関数の動作は、選択範囲のリフレッシュのみを行うように変更されています。11.1.2.5.610以降では、複数グリッド・シートの作成や追加範囲の作成は行われなくなります。

構文

HypRetrieveRange(vtSheetName,vtRange,vtFriendlyName)

ByVal vtSheetName As Variant

ByVal vtRange As Variant

ByVal vtFriendlyName As Variant

パラメータ

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

vtRange: リフレッシュする連続範囲。この範囲には、1つ以上のメンバー・セルとデータ・セルを含める必要があります。vtRangeがNullの場合は、ワークシート全体がリフレッシュされ、リフレッシュする範囲を取得するために、指定されたワークシートでGetUsedRangeが使用されます。

vtFriendlyName: 範囲のリフレッシュに使用される接続の、わかりやすい名前。Nullに設定されると、ワークシートに関連付けられたアクティブな接続を使用して、そのワークシート上の範囲がリフレッシュされます。接続が関連付けられていない場合は、エラーが戻されます。

戻り値

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

例

この例では、必要なデータ・ソースに接続済であることを想定しています。

Public Declare Function HypRetrieveRange Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtRange As Variant, ByVal vtFriendlyName As Variant) As Long
Worksheets("Sheet2").Names.Add name:="MyRange", RefersTo:="=$E$11:$F$28"
Sub Example_RetrieveRange
   Worksheets("Sheet1").Names.Add name:="MyRange", RefersTo:="=$E$11:$F$28"
   sts = HypRetrieveRange(Empty, range("E11:F28"), "Samp1")
      'retrieve by regular range
   sts = HypRetrieveRange(Empty, range("MyRange"), "Samp1")
      'retrieve by named range
End sub