(a)　機能

接続するDBに必要な接続付加情報を設定します。

(b)　形式

 
public void setDescription ( String description )
 

(c)　引数

String description：

接続付加情報を指定します。

(d)　戻り値

なし。

(e)　機能詳細

接続するDBに必要な接続付加情報を設定します。設定する内容と要否を次に示します。

設定内容	設定する内容	設定の要否
HiRDBのポート番号	HiRDBのポート番号を文字列で設定します。	任意
HiRDBの環境変数グループ名	HiRDBの環境変数グループ名を「@HIRDBENVGRP=」に続けて文字列で設定します。環境変数グループ名に半角空白文字，及び半角＠文字を含む場合は，半角引用符（"）で囲んで指定してください。環境変数グループ名を半角引用符で囲んだ場合，最後の半角引用符から文字終端までの文字は無視されます。半角引用符，及び半角コンマを含む環境変数グループ名は指定できません。	任意
HiRDBの環境変数グループ識別子	HiRDBの環境変数グループ識別子を英数字だけの4文字で設定します。	XA接続時は必要

注1

環境変数グループに登録された環境変数は，ユーザ環境変数やHiRDB.INIで登録した環境変数よりも優先されます。

注2

指定例を次に示します。なお，指定例では，JdbhDataSourceクラスのインスタンスの参照を持つ変数名を「ds」としています。

UNIX版の場合：

例1：HiRDBの環境変数グループ名のパスが「/HiRDB_P/Client/HiRDB.ini」の場合

 
ds.setDescription("@HIRDBENVGRP=/HiRDB_P/Client/HiRDB.ini");
 

Windows版の場合：

例1：HiRDBのポート番号を指定する場合

 
ds.setDescription("22200");
 

例2：HiRDBクライアント環境変数登録ツールで登録した環境変数グループ名「HiRDB_ENV_GROUP」を指定する場合

 
ds.setDescription("@HIRDBENVGRP=HiRDB_ENV_GROUP");
 

例3：HiRDBの環境変数グループ名のパスが「C:\HiRDB_P\Client\HiRDB.ini」の場合

 
ds.setDescription("@HIRDBENVGRP=C:\\HiRDB_P\\Client\\HiRDB.ini");
 

例4：HiRDBの環境変数グループ名のパスが「C:\Program△Files\HITACHI\HiRDB\HiRDB.ini」の場合（△は半角空白文字）

 
ds.setDescription("@HIRDBENVGRP=\"C:\\Program△Files\\HITACHI\\HiRDB\HiRDB.ini\"");
 

例5：HiRDBの環境変数グループ識別子が「HDB1」の場合

 
ds.setDescription("HDB1");
 

(f)　発生する例外

XA接続以外の接続で，@から始まる環境変数グループ名を指定した場合，@より後の指定内容に半角スペースがあるときは，SQLExceptionを投入します。