アクティブなデータベースに更新指定を単一文字列として送信します。
構文
ESS_FUNC_M EssUpdate (
hCtx, Store, Unlock, UpdtSpec
);
パラメータ | データ型 | 説明 |
---|---|---|
hCtx |
ESS_HCTX_T |
APIコンテキスト・ハンドル。 |
Store |
ESS_BOOL_T |
データの保管を制御します。TRUEの場合は、データがサーバーに保管されます。FALSEの場合はデータは保管されません。 |
Unlock |
ESS_BOOL_T |
データ・ブロックのロック解除を制御します。TRUEの場合、ロックされているすべての関連ブロックのロックが解除されます(必要に応じてデータの保管後)。FALSEの場合、ブロックのロックは解除されません。 |
UpdtSpec |
ESS_STR_T |
単一文字列としての更新指定。 |
備考
この関数は、EssBeginUpdateを呼び出し、その後EssSendStringを呼び出し、最後にEssEndUpdateを呼び出すのと同じです。更新データはデータベースに保管することも、確認のみ行ってエラーがあれば戻すこともできます。また、この呼出しによって、更新用にロックされていたデータ・ブロックもロック解除できます。
この関数によってデータが保管される場合(StoreフラグがTRUE)、関連データ・ブロックは更新のためにロックされている必要があります(たとえば、LockフラグをTRUEに設定してEssReportを呼び出します)。
呼出し元がメンバーにデータを書き込もうとした場合に、書込み権限がないと、警告が生成され、メンバーは更新されません。
StoreおよびUnlockの両方のフラグがFALSEに設定されている場合、データベースは更新指定の構文確認のみを行います。
戻り値
なし。
アクセス
この関数を使用するには、呼出し元が、アクティブなデータベースに対して書込み権限(ESS_PRIV_WRITE)を持っている必要があります。呼出し元が情報を書き込もうとした場合。
例
ESS_FUNC_M ESS_Update (ESS_HCTX_T hCtx) { ESS_FUNC_M sts = ESS_STS_NOERR; sts = EssUpdate (hCtx, ESS_TRUE, ESS_FALSE, "Year Market Scenario Measures Product 100"); return(sts); }
関連トピック