uCosminexus DocumentBroker Version 5 リファレンス API

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

5.5.16 setRenditionComment(レンディションコメントの設定)

<この項の構成>
(1) 機能
(2) 形式
(3) 引数
(4) 戻り値
(5) 例外

(1) 機能

レンディションに付与するコメントを設定します。

コメントの指定には,コンテンツタイプを表す文字列を指定することを推奨します。レンディションタイプとコメントの間には1バイトのスペースが設定されます。

(2) 形式

void setRenditionComment (
     String      renditionComment
)

(3) 引数

renditionComment(入力)
レンディションに付与するコメントを指定します。
nullを指定した場合は,DocumentBrokerが自動的にコメント("edms-cnv")を付与します。空文字列("")は指定できません。
指定するコメントは,変換するレンディションのレンディションタイプの文字列長とレンディションコメントの文字列長を合わせて255バイト以内で指定してください。255バイトを超えた場合は,エラーとなります。
なお,レンディションコメントには,印刷可能なASCIIコードで記述できる値を指定してください。

(4) 戻り値

なし

(5) 例外

なし