リンク・オブジェクトの更新済バージョンをサーバーに保管します。
構文
EsbLROUpdateObject
(
hCtx, pLinkId, usOption, pLRODesc
)
ByVal
hCtx
As Long
pLinkId
As ESB_LROHANDLE_API_T
ByVal
usOption
As Integer
pLRODesc
As ESB_LRODESC_API_T
| パラメータ | 説明 |
|---|---|
hCtx |
APIコンテキスト・ハンドル。 |
pLinkId |
オブジェクト識別構造体。 |
usOption |
オブジェクトのどの部分を更新するかを指定するオプション。次のいずれかを使用します:
|
pLRODesc |
オブジェクトの説明構造体、ESB_LRODESC_API_T。 |
備考
オブジェクトを作成し、オブジェクトのカタログ・エントリにそれを保管すると、EssbaseはリンクIDを割り当てます。EsbLROGetCatalogを使用して、説明構造体ESB_LRODESC_API_Tに含まれるカタログ・エントリを取得します。次に、説明構造体を変更し、EsbLROUpdateObject()を呼び出して、サーバー上に変更を保存できます。
次のようにusOptionパラメータを指定します:
オブジェクトがセル・ノートである場合、ESB_LRO_CATALOG_APIを使用します。セル・ノートはカタログ・エントリに保管されます。
オブジェクトがファイルの場合は、ESB_LRO_BOTH_APIを使用してファイルのコンテンツおよびカタログの両方を更新します。
カタログ情報のみ(オブジェクトの説明またはユーザー名など)を更新する場合、ESB_LRO_CATALOG.APIを使用します。この場合、ファイルのコンテンツは更新されません。
ファイル・コンテンツのみを更新しカタログを更新しない場合、ESB_LRO_OBJ_APIを使用します。この場合、ファイルのコンテンツおよび変更日のみが更新されます。
リンク・オブジェクトは、次のいずれかのタイプです:
Word文書、Excelスプレッドシートまたはビットマップ・イメージなどのフラット・ファイル。
最大599文字のテキストが含まれるセル・ノート。
別のEssbaseデータベースへのリンク(リンク・パーティション機能)。
戻り値
正常終了の場合は、ESB_STS_NOERRが戻されます。それ以外の場合、エラー・コードが戻されます。
アクセス
この関数を呼び出すには、データ・セルまたはアクティブなデータベースに対して書込み権限(ESB_PRIV_WRITE)を持っている必要があります。
例
Declare Function EsbLROUpdateObject Lib "esbapin" _
(ByVal hCtx As Long, pLinkID As ESB_LROHANDLE_API_T, _
ByVal usOption As Integer, _
pLRODesc As ESB_LRODESC_API_T) As Long
Public Sub ESB_LROUpdateObject() Dim LinkID As ESB_LROHANDLE_API_T
Dim Desc As ESB_LRODESC_API_T
Dim opt As Integer
LinkID.hObject = 1
LinkID.cellKey.cellOffset = 0
LinkID.cellKey.blkOffset = 198
LinkID.cellKey.segment = 0
Desc.userName = "admin"
Desc.ObjType = ESB_LROTYPE_CELLNOTE_API
Desc.note = "New Note from DFS"
opt = ESB_STORE_OBJECT_API
sts = EsbLROUpdateObject(hCtx, LinkID, _
opt, Desc)
End Sub
関連トピック