EssPutObject

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

構文

            ESS_FUNC_M EssPutObject (
            hCtx, ObjType, AppName, DbName, ObjName, LocalName, Unlock
            );

パラメータ	データ型	説明
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	クライアント上のローカル・ソース・ファイルのフル・パス名。
Unlock	ESS_BOOL_T	オブジェクトのロック解除を制御するフラグ。TRUEの場合、サーバー・オブジェクトのロックが解除され、他のユーザーによる更新が許可されます。

備考

サーバー上に存在しているオブジェクトを配置するには、呼出し元によって事前にロックされている必要があります。オブジェクトがサーバー上になければ、新規作成されます。

戻り値

正常終了の場合は、オブジェクトがLocalNameで指定したローカル・ファイルからサーバーにコピーされます。

アクセス

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

例

         ESS_FUNC_M 
ESS_PutObject (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        UnLock; 
   
   AppName   = "Sample";
   DbName    = "Basic";
   ObjName   = "Basic1";
   ObjType   = ESS_OBJTYPE_OUTLINE; 
   LocalName = "C:\\Hyperion\\products\\Essbase\\EssbaseClient\\Test.otl";
   UnLock    = ESS_TRUE;
   
   sts = EssPutObject (hCtx, ObjType, AppName,
         DbName, ObjName, LocalName, UnLock); 
   return (sts);
}