EssGetObject

サーバーまたはクライアントのオブジェクト・システムからローカル・ファイルにオブジェクトをコピーし、オプションでロックします。

構文

            ESS_FUNC_M EssGetObject (
            hCtx, ObjType, AppName, DbName, ObjName, LocalName, Lock
            );

パラメータ	データ型	説明
hCtx	ESS_HCTX_T	APIコンテキスト・ハンドル。EssCreateLocalContextによって戻されたローカル・コンテキスト・ハンドルの場合もあります。
ObjType	ESS_OBJTYPE_T	オブジェクト・タイプ(単一のタイプのみ)。使用可能な値のリストは、ビットマスク・データ型(C)を参照してください。
AppName	ESS_STR_T	アプリケーション名。
DbName	ESS_STR_T	データベース名。NULLの場合は、アプリケーション・サブディレクトリを使用します。
ObjName	ESS_STR_T	取得するオブジェクト名。
LocalName	ESS_STR_T	クライアント上のローカル・コピー先ファイルのフル・パス名。
Lock	ESS_BOOL_T	オブジェクトのロックを制御するフラグ。TRUEの場合は、オブジェクトがロックされ、他のユーザーによる更新を防止します。

備考

オブジェクトをロックするには、そのオブジェクトがサーバーに存在している必要があり、かつ他のユーザーによってロックされていないことが必要です。クライアント上でのロックはサポートされていません。

戻り値

正常終了の場合は、オブジェクトはLocalNameで指定されているローカル・ファイルにコピーされます。

アクセス

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

例

         ESS_FUNC_M 
ESS_GetObject (ESS_HCTX_T hCtx)
{
   ESS_FUNC_M         sts = ESS_STS_NOERR;
   ESS_STR_T         AppName;
   ESS_STR_T         DbName;
   ESS_STR_T         ObjName;       
   ESS_OBJTYPE_T     ObjType;     
   ESS_STR_T         LocalName;
   ESS_BOOL_T        Lock; 
   
   
   AppName = "Sample";
   DbName  = "Basic";
   ObjName = "Basic";
   ObjType = ESS_OBJTYPE_OUTLINE; 
   LocalName = "C:\\Hyperion\\products\\Essbase\\EssbaseClient\\client\\Basic.otl";
   Lock    = ESS_TRUE;
   
   sts = EssGetObject (hCtx, ObjType, AppName,
         DbName, ObjName, LocalName, Lock); 
   return (sts);
}