EsbLROAddObject

レポート・オブジェクトをEssbaseデータベースのデータ・セルにリンクします。

構文

            EsbLROAddObject 
             (
            hCtx, memCount, MemComb, usOption, pLRODesc
            )
ByVal 
            hCtx
                 As Long
ByVal 
            memCount
             As Long
ByVal 
            MemComb
              As String
ByVal 
            usOption
             As Integer
      
            pLRODesc
             As ESB_LRODESC_API_T

パラメータ	説明
hCtx	APIコンテキスト・ハンドル。
MemCount	pMemCombで指定したメンバー数。
MemComb	リンクするデータ・セルを定義するメンバー名(EOL、CRで区切られる)の文字列。
usOption	オブジェクトの保管先を指定するオプション。次のいずれかを使用します: ESB_STORE_OBJECT_APIは、オブジェクトをサーバーに保管します ESB_NOSTORE_OBJECT_APIは、サーバー上に保管しません
pLRODesc	オブジェクトの説明構造体ESB_LRODESC_API_Tへのポインタ。

備考

リンク・オブジェクトは、次のいずれかのタイプです:
- Word文書、Excelスプレッドシートまたはビットマップ・イメージなどのフラット・ファイル。
- 最大599文字のテキストが含まれるセル・ノート。
- URLへのリンク。
- その他のデータベースへのリンク(リンク・パーティション機能)。
オブジェクトをサーバーに保管しない(usOption)を選択した場合、サーバーにはリンク情報のみが保管され、アプリケーションでオブジェクトに関するすべてのファイル管理タスクを行うことになります。
セル・ノートは、常にサーバーに保管されるため、usOptionパラメータは無視されます。
URLリンク・オブジェクトに対するusOptionパラメータは、常にESB_NOSTORE_OBJECT_APIである必要があります。
EsbLROAddObjectでは、現在ログインしているユーザー名がオブジェクトに対する作成者ユーザー名として使用され、pLRODescオブジェクト説明構造体で指定したユーザー名は無視されます。

戻り値

正常終了の場合は、ESB_STS_NOERRが戻されます。それ以外の場合、エラー・コードが戻されます。

アクセス

この関数を呼び出すには、データ・セルまたはアクティブなデータベースに対して書込み権限(ESB_PRIV_WRITE)を持っている必要があります。

例

         Declare Function EsbLROAddObject Lib "esbapin" _
(ByVal hCtx As Long, ByVal memCount As Long, _ 
ByVal memComb As String, ByVal usOption As Integer, _
pLRODesc As ESB_LRODESC_API_T) As Long

Public Sub ESB_LROAddObject()   Dim Desc As ESB_LRODESC_API_T
   Dim memCount As Long
   Dim memComb As String
   Dim opt As Integer
   Dim i As Integer
   
   Desc.userName = "Admin"
   
   Desc.ObjType = ESB_LROTYPE_CELLNOTE_API
   Desc.note = "Note from DFS"   memCount = 5
   memComb = "Jan" & vbLf & "Sales" & vbLf & _
             "Cola" & vbLf & "Utah" & vbLf & _
             "Actual"   opt = ESB_NOSTORE_OBJECT_API
            
   sts = EsbLROAddObject(hCtx, memCount, memComb, _
                         opt, Desc)   
End Sub