(a)　機能

データベースへの接続に必要な情報（接続付加情報）を設定します。

(b)　形式

 
public void setDescription ( String description ) throws SQLException
 

(c)　引数

String description：

接続付加情報を指定します。ナル値の場合は，このメソッドによって現在までに設定した接続付加情報を無効とし，初期状態に戻します。

(d)　戻り値

なし。

(e)　機能詳細

このメソッドで設定する接続付加情報を次に示します。

設定内容	設定する内容	設定の要否
HiRDBのポート番号	HiRDBのポート番号を文字列で設定します。 HiRDBのポート番号の各設定方法での優先順位については，「18.11　接続情報の優先順位」を参照してください。	任意
HiRDBクライアントの環境変数グループ名	HiRDBクライアントの環境変数グループ名を，「@HIRDBENVGRP=」に続けて絶対パス名で指定します。次の点に注意してください。 「@HIRDBENVGRP=,」のように，"="の後に何も指定しないと，この項目による指定がないものとみなされます。 環境変数グループ名は大文字と小文字を区別するため，注意してください。なお，環境変数グループ名はOSに依存します。 環境変数グループ名に半角スペース，又は半角＠文字を含む場合，半角引用符（"）で囲んでください。環境変数グループ名を半角引用符で囲んだ場合，最後の半角引用符から文字終端までの文字は無視されます。また，半角引用符，半角コンマを含む環境変数グループ名は指定できません。 Windowsの場合，HiRDBクライアント環境変数登録ツールで登録した環境変数グループ名は指定できません。	任意
HiRDBの環境変数グループ識別子	HiRDBの環境変数グループ識別子を，英数字だけの4文字で設定します。	XA接続時は必要

注1

指定例を次に示します。なお，指定例では，PrdbDataSourceクラスのインスタンスの参照を持つ変数名を「ds」とします。また，△は半角スペースを示します。

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

 
ds.setDescription ("22200");
 

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

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

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

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

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

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

例5：XA接続時，HiRDBの環境変数グループ識別子を指定する場合

 
ds.setDescription ("HDB1");ds.setXAOpenString ("HDB1+C:\\Program△Files\\HITACHI\\HiRDB\\HiRDB.ini");
 

注2

環境変数グループ名を指定する場合は，指定内容に半角スペースを含めないでください。エラーになる指定例を次に示します。

@△HIRDBENVGRP=/HiRDB_P/Client/HiRDB.ini @HIRDBENVGRP△=/HiRDB_P/Client/HiRDB.ini @HIRDBENVGRP=△/HiRDB_P/Client/HiRDB.ini @HIRDBENVGRP=/HiRDB_P/Client/HiRDB.ini△

注　△は半角スペースを示します。

(f)　発生する例外

半角＠文字から始まる環境変数グループ名を指定する場合，半角＠文字より後の指定内容に半角スペースがあるときは，SQLExceptionを投入します。