CdbrEqlStatement::Setメソッド

機能

edmSQL文の設定

形式

DmaBoolean Set (
 pDmaString_T       pEqlStatement)

詳細

実行予定のedmSQL文を設定するメソッドです。

このメソッドで設定したedmSQL文は,CdbrEqlStatement::Executeメソッドのコール時に有効になります。

なお,このメソッドでは設定されたedmSQL文のチェックはしません。このメソッドは実行予定のedmSQL文を設定するだけです。edmSQL文のチェックはCdbrEqlStatement::Executeメソッドで実施されます。したがって,edmSQL文の構文に関するエラーはCdbrEqlStatement::Executeメソッドで返却されます。

CdbrEqlStatement::Initializeメソッドがコールされていない状態でこのメソッドをコールした場合は,エラーになります。

戻り値がDMA_FALSEの場合,設定されたedmSQL文は保証できません。

edmSQL文の仕様と文法については,マニュアル「DocumentBroker Version 3 クラスライブラリ C++ 解説」の「4. オブジェクトの検索」を参照してください。

引数

pEqlStatement(入力)

実行予定のedmSQL文を指定します。edmSQL文が指定されていない場合(NULLを指定した場合)はエラーになります。

戻り値

DMA_TRUE  正常終了

DMA_FALSE 異常終了

戻り値の詳細

major_codeminor_code説明対処
ERR_DBRERR_EQL_NOT_INITIALIZE初期化が実行されていません。初期化を実行してください。
ERR_DMADMARC_BAD_PARAMETER不正な引数が入力されました。正しい引数を指定してください。
ERR_DMADMARC_NO_MEMORYメモリ不足で実行できません。メモリを増設してください。またはメモリを大量に消費しているアプリケーションを停止させて,処理を再実行してください。
ERR_DMADMARC_UNEXPECTED予期しないエラーが発生しました。処理を終了してください。