CdbrSession::GetDocSpaceCharacterSetメソッド

機能

接続する文書空間の文字コード種別の取得

形式

DmaBoolean GetDocSpaceCharacterSet (
 pDmaInteger32   plDocSpaceCharacterSet )

詳細

セッションが接続している文書空間で使用している文字コード種別を取得するメソッドです。

一つのユーザプログラムで文字コード種別の異なる複数のDocumentBrokerサーバに接続する場合に,このメソッドをコールすることで動的に接続先のDocumentBrokerサーバの文字コード種別に合わせた処理の分岐が可能となります。

引数

plDocSpaceCharacterSet(出力)

セッションが接続している文書空間の文字コード種別を格納する領域を指定します。NULLを指定するとDMARC_BAD_PARAMETERのエラーになります。

正常終了すると次のいずれかの値になります。

戻り値

DMA_TRUE  正常終了

DMA_FALSE 異常終了

戻り値の詳細

major_codeminor_code説明対処
ERR_CORBACORBAの戻り値が設定されます。CORBAでエラーが発生しました。ユーザプログラムでは対処できません。エラー情報として文字列の値を取得して,ユーザプログラムを終了してください。
ERR_DBRERR_SESSION_NOT_CONNECTセッションが接続されていません。セッションを接続してください。
ERR_DMADMARC_BAD_PARAMETER不正な引数が入力されました。正しい引数を指定してください。
ERR_DMADMARC_NO_MEMORYメモリ不足で実行できません。メモリを増設してください。またはメモリを大量に消費しているアプリケーションを停止させて,処理を再実行してください。
ERR_DMADMARC_UNEXPECTED予期しないエラーが発生しました。処理を終了してください。