EssLROGetObject

Essbaseデータベース内のデータ・セルにリンクされているオブジェクトを取得します。

構文

            ESS_FUNC_M EssLROGetObject (
            hCtx, plinkId, targetFile, usOption, 
pRetLRODesc
            );

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

備考

セル・ノートはオブジェクトのカタログ・エントリの一部です。セル・ノートを取得するには、usOptionパラメータのESS_LRO_CATALOG_APIを使用します。リンクされているノートが構造体ESS_LRODESC_API_Tに含まれます。

戻り値

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

アクセス

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

例

         ESS_FUNC_M ESS_LRO GetObject (ESS_HCTX_T hCtx)
{
        ESS_FUNC_M              sts = ESS_STS_NOERR;
        ESS_LROHANDLE_API_T     linkId;
        ESS_LRODESC_API_T       lroDesc;
        ESS_USHORT_T            usOption = 2;  /* Default is catalog */
        ESS_CHAR_T              targetFile[ESS_ONAMELEN_API];
        memset(&lroDesc, 0, sizeof(ESS_LRODESC_API_T));
        memset(&linkId, 0, sizeof(ESS_LROHANDLE_API_T));
        /* Linked object is a LRO. (Windows Application) */
        linkId.hObject = 4;
        linkId.cellKey.cellOffset = 136;
        linkId.cellKey.blkOffset = 113.0;
        linkId.cellKey.segment = 0.0;
        usOption = ESS_LRO_BOTH_API ;  /* Get the catalog and the object */
        strcpy ( targetFile , "c:\\temp\\lrofile");
        sts = EssLROGetObject(hCtx, &linkId, targetFile, usOption, &lroDesc);
        if (sts)
        {
                printf("Could not get object\n");
        }
        return sts;
}