CdbrEqlStatement::GetACLModeメソッド

機能

アクセス制御モードの取得

形式

DmaBoolean GetACLMode(
 pDmaInteger32          plACLMode)

詳細

アクセス制御機能付きで検索(edmSQL文)を実行するかどうかを示すアクセス制御モードを取得するメソッドです。

このメソッドで取得するモードは,CdbrEqlStatement::Executeメソッド実行時に確定したモード(実際に動作しているモード)です。CdbrEqlStatement::Executeメソッド実行前にCdbrEqlStatement::ChangeACLModeメソッドで指定したモードは返却されないので注意してください。

なお,一度もCdbrEqlStatement::Executeメソッドを実行していない状態でこのメソッドを実行した場合,DBR_QUERY_WITHOUT_ACLが返却されます。CdbrEqlStatement::Initializeメソッドがコールされていない状態でこのメソッドをコールすると,エラーになります。また,アクセス制御機能を使用していない文書空間に接続しているときにこのメソッドをコールするとエラーになります。

戻り値がDMA_FALSEの場合は,取得したアクセス制御モードは保証できません。

引数

plACLMode(出力)

取得したアクセス制御モードが設定されます。モードが設定される領域を指定してください。領域が指定されていない場合(NULLである場合)にはエラーになります。

次のどちらかが設定されます。

戻り値

DMA_TRUE  正常終了

DMA_FALSE 異常終了

戻り値の詳細

major_codeminor_code説明対処
ERR_CORBACORBAの戻り値が設定されます。CORBAでエラーが発生しました。ユーザプログラムでは対処できません。エラー情報として文字列の値を取得して,ユーザプログラムを終了してください。
ERR_DBRERR_ACCESSCONTROL_NOT_SUPPORTEDアクセス制御対応のデータベースを使用していません。アクセス制御付き検索の実行モードを変更する場合は,アクセス制御対応のデータベースを使用してください。
ERR_DBRERR_EQL_NOT_INITIALIZE初期化が実行されていません。初期化を実行してください。
ERR_DBRERR_SESSION_NOT_CONNECTセッションが接続されていません。セッションを接続してください。
ERR_DMADMARC_BAD_PARAMETER不正な引数が入力されました。正しい引数を指定してください。