EssLROUpdateObject

サーバーにLROの更新済バージョンを保管します。

構文

            ESS_FUNC_M EssLROUpdateObject (
            hCtx, plinkId, usOption, pLRODesc
            );

パラメータ	データ型	説明
hCtx	ESS_HCTX_T	APIコンテキスト・ハンドル。
plinkId	ESS_LROHANDLE_API_T	オブジェクト識別構造体に対するポインタ。
usOption	ESS_USHORT_T	オブジェクトとカタログ・エントリの一方またはその両方を保管するかどうかを指定するオプション。次のいずれかを使用します: ESS_LRO_OBJ_API オブジェクトのみ保管します。 ESS_LRO_CATALOG_API カタログ・エントリのみ保管します。 ESS_LRO_BOTH_API オブジェクトとカタログ・エントリを保管します。
pLRODesc	ESS_LRODESC_API_T	オブジェクト記述構造体へのポインタ。

備考

リンク・オブジェクトは、次のいずれかのタイプです:
- Word文書、Excelスプレッドシートまたはビットマップ・イメージなどのフラット・ファイル。
- 最大599文字のテキストが含まれるセル・ノート。
- 別のEssbaseデータベースへのリンク(リンク・パーティション機能)。
セル・ノートはオブジェクトのカタログ・エントリの一部です。セル・ノートを保管するには、ESS_LRO_CATALOG_APIをusOptionパラメータに使用します。リンクされているノートが構造体ESS_LRODESC_API_Tに含まれます。
オブジェクトを最後に変更したユーザー名と変更日も更新されます。

戻り値

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

アクセス

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

例

         ESS_STS_T ESS_LRO UpdateObject (ESS_HCTX_T hCtx)
{
        ESS_STS_T               sts = ESS_STS_NOERR;
        ESS_LROHANDLE_API_T     linkId;
        ESS_LRODESC_API_T       lroDesc;
        ESS_USHORT_T            usOption = 2;   /* Default is catalog */

        memset (&linkId, 0, sizeof(ESS_LROHANDLE_API_T));
        memset (&lroDesc, 0, sizeof(ESS_LRODESC_API_T));

        linkId.hObject = 25;
        linkId.cellKey.cellOffset = 149;
        linkId.cellKey.blkOffset = 113.0;
        linkId.cellKey.segment = 0.0;

        /* Linked object is a LRO. (Windows Application) */
        lroDesc.usObjType = 1;

        /* Update both object and catalog */
        usOption = ESS_LRO_BOTH_API; 
        strcpy (lroDesc.lro.lroInfo.objName, "e:\\lro\\lroex.c");
        strcpy (lroDesc.lro.lroInfo.objDesc, "My C file");  

        strcpy (lroDesc.userName, "user1");
        lroDesc.linkId.hObject = linkId.hObject;

        sts = EssLROUpdateObject(hCtx, &linkId, usOption, &lroDesc);
        if (sts)
        {
                printf("Could not update linked object.\n");
        }
        return sts;
}