CdbrSession::SetReferencePathメソッド
機能
コンテント格納先ベースパスの設定
形式
DmaBoolean SetReferencePath(
pDmaString_T pTargetContentPath)
詳細
リファレンスファイル管理機能を使用して,コンテントを任意の領域に格納する場合に,コンテント格納先ベースパスを指定します。
コンテントロケーションを相対パスで管理するオブジェクトに対して,このメソッドでコンテント格納先ベースパスが設定されていない場合,エラーになります。
コンテント格納先ベースパスとSDBR_REFERENCE_PATHINFO構造体のメンバpTargetPathで指定するコンテント格納先パスは,結合して絶対パスとして使用されます。このとき,DocumentBrokerがパスの区切り文字として"/"(半角)を設定します。ただし,ユーザがコンテント格納先ベースパスの末尾またはpTargetPathで指定するコンテント格納先パスの先頭にパスの区切り文字を指定している場合は,パスの区切り文字は設定されません。
引数
pTargetContentPath(入力)
リファレンスファイル管理機能でコンテントの格納先となるベースパスを指定します。
この引数は,DocumentBrokerサーバがWindowsの場合UNC形式のパスで指定することもできます。ただし,設定するコンテント格納先ベースパスにコンピュータ名またはIPアドレスだけを指定することはできません。
次に示す場合は,DMARC_BAD_PARAMETERのエラーになります。
設定した値を削除する場合は,NULLを指定します。
この引数に指定した文字列長が,Windowsの場合260バイト以上,AIXの場合1023バイト以上であるとDMARC_BAD_PARAMETERのエラーになります。また,指定するパスの中に,カレントディレクトリの一つ上位のディレクトリを示す".."は指定できません。指定した場合,DMARC_BAD_PARAMETERのエラーになります。
戻り値
DMA_TRUE 正常終了
DMA_FALSE 異常終了
戻り値の詳細
major_code | minor_code | 説明 | 対処 |
---|---|---|---|
ERR_CORBA | CORBAの戻り値が設定されます。 | CORBAでエラーが発生しました。 | ユーザプログラムでは対処できません。エラー情報として文字列の値を取得して,ユーザプログラムを終了してください。 |
ERR_DBR | ERR_INVALID_STATUS | セッションの状態が不正です。一つのセッションに同時に複数のメソッド処理要求が出されています。 | 一つのセッションに対しては,一度に一つの処理要求しか出さないように見直してください。 |
ERR_DBR | ERR_SESSION_NOT_CONNECT | セッションが接続されていません。 | セッションを接続してください。 |
ERR_DMA | DMARC_BAD_PARAMETER | 不正な引数が入力されました。 | 正しい引数を指定してください。 |
ERR_DMA | DMARC_NO_MEMORY | メモリ不足で実行できません。 | メモリを増設してください。またはメモリを大量に消費しているアプリケーションを停止させて,処理を再実行してください。 |
ERR_DMA | DMARC_NOT_SUPPORTED | このセッションまたはオブジェクトではサポートされていないメソッドです。 | この操作は実行できません。 |
ERR_DMA | DMARC_UNEXPECTED | 予期しないエラーが発生しました。 | 処理を終了してください。 |
ERR_DMA | EDMRC_NOT_OUTTRANSACTION | トランザクション内でメソッドが呼ばれました。 | CdbrSession::Begin()メソッドを呼び出す前に,この操作を実行してください。 |