メソッド名

実際に指定する形式について記述しています。

引数は，特に断りのないかぎり，形式に示してある順序で記述してください。

 
void  Connect (LPCTSTR lpctUID，
                 LPCTSTR lpctPWD,
                 LPCTSTR lpctDBN,
                 LPCTSTR lpctOPT = NULL,  
                 LPCTSTR lpctAbstractName,
                 UINT16 swWait = LOCK_OPT_NOWAIT,
                 UINT16 swTimeout = 0,
                 UINT16 swSync = STMT_SYNC)       throw DBSQLCA

引数のうち=のない引数（lpctUIDなど）は，省略できないことを示します。

=のある引数（swWait = LOCK_OPT_NOWAITなど）は，指定を省略できることがあります。途中の引数を一つ又は複数省略することはできません。例えば上記の例では，引数swWait, swTimeout, swSyncのすべてを省略することはできますが，swTimeoutだけを省略することはできません。

=の右辺の値は，デフォルト値であることを示しています。この例では，引数swWait指定を省略するとLOCK_OPT_NOWAITが仮定されることを示しています。

戻り値には，メソッドの戻り値の型（データ型として記述）や説明が記述してあります。

また，主に戻り値の説明中にある（又は機能詳細などにある場合もあります），TRUE及びFALSEの表記は，それぞれ非0及び0を意味しています。ヘッダではTRUEを１と定義していますが，これは便宜上のものであり，TRUEの場合でもBOOLEAN型の戻り値として１以外の値が返ることがあります。

したがって，BOOLEAN型の戻り値でTRUEかどうかを判定する場合は，例１のような方法ではなく，例２に示す方法で判定してください。

（例１）

 BOOLEAN bFlag;
        ：
 if(bFlag == TRUE)
 {
 // TRUE
 }

（例２）

 BOOLEAN bFlag;
       ：
 if(bFlag)
 {
   // TRUE
 }

メソッドでスローする可能性のある代表的なエラーが記述してあります。ここに書かれていないエラーをスローすることもあります。また，項目の先頭に記述されているDBSQLCA(RetCode)は，DBSQLCAクラスのRetCodeプロパティにエラーがスローされることを示しています。

DB_ERROR_NOT_ENOUGH_MEMORY: エラーコードを示します。

アプリケーション作成時には，RetCodeプロパティに返るエラーコードを直接，比較，判定に利用できます。なお，アプリケーションで利用するためには，include文でヘッダーファイルdbbroker.hファイルをインクルードしておきます。

 DBSQLCA* pError = NULL;
   try
   {
     : 
     pError = custom.GetErrorStatus();
                             // SQL実行時のエラー情報を取得
     if(pError->RetCode != 0)
                             // DBSQLCAオブジェクトのRetCodeで確認
       throw *pError;
     : 
   }
   catch(DBSQLCA e)
   {
   }

   try
   {
     : 
     pCon->Connect("uid","pass",NULL,"RDB");
                                        // データベースとの接続
     : 
   }
   catch(DBSQLCA e)
   {
   if(e.RetCode==DB_ERROR_NOT_ENOUGH_MEMORY)
                                       //エラーコードを判定に使う
     : 
   }