3.1.19  initUserProp(文字列型)

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

(1) 機能

ユーザプロパティ,および文書種別マスタに使用するプロパティで,文字列型のプロパティをシステムに登録します。

このメソッドを複数回コールして,使用する文字列型のプロパティをすべて登録する必要があります。

なお,DecmDoc#setDocProp()メソッドの設定値を有効にする場合は,必ずこのメソッドでプロパティを定義してください。定義していないプロパティの場合,DecmDoc#setDocProp()メソッドで値を設定しても,その値は有効となりません。

(2) 形式

void initUserProp(
 String propName,
 int type,
 int size
)

(3) 引数

String propName
プロパティ名を指定します。
int type
プロパティ名に対する型を指定します。
指定できる値を次に示します。
  • DecmFactory.PROP_TYPE_STRING(文字列型)
int size
プロパティ長を正の整数で指定します。

(4) 戻り値

なし

(5) 例外

DecmApiInvalidParamException
  • 引数propNameに対する「通常文字列の設定チェック」に失敗した場合
  • 引数typeに対して,指定できる値以外を指定した場合
  • 引数sizeに対して,指定できる値以外を指定した場合
  • 引数propNameに対して,すでに登録済みの値を指定した場合