EssBeginUpdate

アクティブ・データベースに対して更新指定の送信を開始します。この呼出しの後、EssSendStringを呼び出して更新指定を送信し、最後にEssEndUpdateを呼び出す必要があります。更新データはデータベースに保管することも、確認のみ行ってエラーがあれば戻すこともできます。また、この呼出しによって、更新用にロックされていたデータ・ブロックもロック解除できます。

構文

            ESS_FUNC_M EssBeginUpdate (
            hCtx, Store, Unlock
            );

パラメータ	データ型	説明
hCtx	ESS_HCTX_T	APIコンテキスト・ハンドル。
Store	ESS_BOOL_T	データの保管を制御します。TRUEの場合は、データがサーバーに保管されます。FALSEの場合はデータは保管されません。
Unlock	ESS_BOOL_T	データ・ブロックのロック解除を制御します。TRUEの場合、ロックされているすべての関連ブロックのロックが解除されます(必要に応じてデータの保管後)。FALSEの場合、ブロックのロックは解除されません。

備考

この関数を呼び出した場合は、その後でEssSendStringを1回以上呼び出し、最後にEssEndUpdateを実行する必要があります。
この関数の後に呼び出したEssSendStringへ渡される各文字列の末尾は、改行復帰文字シーケンス("\r\n")である必要があります。
StoreおよびUnlockの両方のフラグがFALSEに設定されている場合、データベースは更新指定の構文確認のみを行います。
Unicode対応Essbaseアプリケーションとの通信にCのメインAPIを使用するUnicodeクライアントは、この関数の呼出し直後に、テキスト・ストリーム内のUTF-8でエンコードされたバイト・オーダー・マーク(BOM)を送信する必要があります。例としては、バイト・オーダー・エンコーディングの指定を参照してください。

戻り値

なし。

アクセス

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

例

         ESS_VOID_T 
ESS_BeginUpdate(ESS_HCTX_T hCtx)
{
   ESS_FUNC_M      sts = ESS_STS_NOERR;
   ESS_BOOL_T   Store;
   ESS_BOOL_T   Unlock; 
   ESS_STR_T    Query;
   
   Store = ESS_TRUE;
   Unlock = ESS_FALSE;
   Query = "Year Market Scenario Measures Product 12345";
                  
   /* Begin Update */
   sts = EssBeginUpdate (hCtx, Store, Unlock);  
   
   /* Send update specification */
   if(!sts)
      sts = EssSendString(hCtx, Query);
      
   /* End Update */
   if(!sts)
      sts = EssEndUpdate(hCtx);      
}