EsbOtlOpenOutline

既存のアウトラインを開いて読み取ります。アウトラインに対する操作を実行する前に、この関数(またはEsbOtlNewOutline())を呼び出す必要があります。

構文

            EsbOtlOpenOutline
             (
            hCtx, pObject, fLock, fKeepTrans, phOutline
            )
ByVal 
            hCtx
                   As Long
      
            pObject
                As ESB_OBJDEF_T
ByVal 
            fLock
                  As Integer
ByVal 
            fKeepTrans
             As Integer
      
            phOutline
              As Long
パラメータ説明

hCtx

Essbaseコンテキスト・ハンドル。

pObject

開く対象のアウトライン・オブジェクト。

fLock

開いたときにアウトラインをロックするかどうかを特定するフラグ。サーバー・アウトラインの場合にのみ有効です。

fKeepTrans

トランザクションを保持するかどうかを特定するフラグ。

既存のアウトラインを開いて変更する場合、データベースの再構築を行ってデータを保持する場合には、フラグをESB_YESに設定してください。ESB_YESでは、アウトラインに対する操作のログが残されます。

空のアウトラインから始める場合や、再構築の際にデータを保存しない場合には、このフィールドをESB_NOに設定してください。ESB_NOに設定すると、ログがとられないので、時間やメモリーを節約できます。

phOutline

ESB_HOUTLINE_Tの戻り変数。このハンドルはAPIによって設定され、後続のアウトラインAPI関数に渡される必要があります。

備考

戻り値

正常終了の場合は0が戻されます。それ以外の場合は、次のいずれかの値が戻されます:

アクセス

この関数を使用するには、呼出し元は指定したアプリケーション、アウトライン・オブジェクトが含まれているデータベースのいずれか、またはその両方に対して、適切なレベルのアクセス権を持っている必要があります。アウトライン・オブジェクトをロックするには(lockフラグをESB_YESに設定)、指定したアプリケーションまたはアウトラインが含まれているデータベースに対して、アプリケーション・デザイナまたはデータベース・デザイナ権限(ESB_PRIV_APPDESIGNまたはESB_PRIV_DBDESIGN)を持っている必要があります。

例

         Declare Function EsbOtlOpenOutline Lib 
"ESBOTLN.DLL" (ByVal hCtx As Long, pObject As ESB_OBJDEF_T,
ByVal fLock As Integer, ByVal fKeepTrans As Integer,
phOutline As Long) As Long

Sub ESB_OtlOpenOutline()
Dim sts As Long
Dim Object As ESB_OBJDEF_T
Dim hOutline As Long
Object.hCtx = hCtx
Object.Type = ESB_OBJTYPE_OUTLINE
Object.AppName = "Sample"
Object.DbName = "Basic"
Object.FileName = "Basic"
sts = EsbOtlOpenOutline(hCtx, Object,
ESB_YES, ESB_YES, hOutline) 
End Sub

関連トピック