uCosminexus DocumentBroker Version 3 クラスライブラリ C++ リファレンス 基本機能編

[目次][用語][索引][前へ][次へ]

CdbrSession::GetReferencePathメソッド

機能

コンテント格納先ベースパスの取得

形式

DmaBoolean GetReferencePath(
  ppDmaString_T     ppTargetContentPath)

詳細

リファレンスファイル管理機能を使用して,コンテントを任意の領域に格納する場合,CdbrSession::SetReferencePathメソッドで設定したコンテント格納先ベースパスを取得します。

この文字列領域は,オブジェクト内に確保されて,オブジェクトを削除するときに同時に削除されます。したがって,メソッドをコールしたユーザが削除する必要はありません。オブジェクトの削除後も,この値を使用したい場合は,内容をほかの領域にコピーしてください。

引数

ppTargetContentPath(出力)

リファレンスファイル管理機能でコンテントの格納先として設定したベースパスへのポインタを格納する領域を指定します。NULLを指定した場合,DMARC_BAD_PARAMETERのエラーになります。値が設定されていない場合は,NULLが返却されます。

戻り値

DMA_TRUE  正常終了

DMA_FALSE 異常終了

戻り値の詳細

major_code minor_code 説明 対処
ERR_DBR ERR_INVALID_STATUS セッションの状態が不正です。一つのセッションに同時に複数のメソッド処理要求が出されています。 一つのセッションに対しては,一度に一つの処理要求しか出さないように見直してください。
ERR_DBR ERR_SESSION_NOT_CONNECT セッションが接続されていません。 セッションを接続してください。
ERR_DMA DMARC_BAD_PARAMETER 不正な引数が入力されました。 正しい引数を指定してください。
ERR_DMA DMARC_NOT_SUPPORTED このセッションまたはオブジェクトではサポートされていないメソッドです。 この操作は実行できません。
ERR_DMA DMARC_UNEXPECTED 予期しないエラーが発生しました。 処理を終了してください。