プロパティ名,又はメソッド名
機能
各プロパティ,又はメソッドの機能概要について記述しています。
形式
実際に指定する形式について記述しています。
引数は,特に断りのないかぎり,形式に示してある順序で記述してください。
DBDriver *Driver (LPCTSTR lpctAbstractName,
LPCTSTR lpctOptions = NULL,
UINT16 swTimeout = 0) throw DBSQLCA
引数のうち=のない引数(lpctAbstractName)は,省略できないことを示します。
=のある引数(lpctOptions=NULL,swTimeout=0)は,指定を省略できることがあります。途中の引数を一つ又は複数省略することはできません。上記の例では,引数lpctAbstractNameだけを指定することはできますが,lpctOptions だけを省略して,lpctAbstract及びNameswTimeoutを指定することはできません。 また,=の右辺の値は,デフォルト値であることを示しています。この例では,引数lpctOptionsの指定を省略するとNULLが,引数swTimeoutの指定を省略すると0が仮定されることを示しています。
引数
形式で説明されている引数とその意味について記述しています。
戻り値
戻り値には,メソッドの戻り値の型(データ型として記述)や説明が記述してあります。
また,主に戻り値の説明中にある(又は機能詳細などにある場合もあります),TRUE及びFALSEの表記は,それぞれ非0及び0を意味しています。ヘッダではTRUEを1と定義していますが,これは便宜上のものであり,TRUEの場合でもBOOLEAN型の戻り値として1以外の値が返ることがあります。
したがって,BOOLEAN型の戻り値でTRUEかどうかを判定する場合は,例1のような方法ではなく,例2に示す方法で判定してください。
(例1)
BOOLEAN bFlag;
:
if(bFlag == TRUE)
{
// TRUE
}
(例2)
BOOLEAN bFlag;
:
if(bFlag)
{
// TRUE
}
機能詳細
各プロパティやメソッドの解説が記述してあります。
発生する例外
メソッドでスローする可能性のある代表的なエラーが記述してあります。ここに書かれていないエラーをスローすることもあります。また,項目の先頭に記述されているDBSQLCA(RetCode)は,DBSQLCAクラスのRetCodeプロパティにエラーがスローされることを示しています。
アプリケーション作成時には,RetCodeプロパティに返るエラーコードを直接,比較,判定に利用できます。なお,アプリケーションで利用するためには,include文でヘッダーファイルdbbroker.hファイルをインクルードしておきます。
DBSQLCA* pError = NULL;
try
{
:
pError = pPrep->GetErrorStatus();
// SQL実行時のエラー情報を取得
if(pError->RetCode != 0)
// DBSQLCAオブジェクトのRetCodeで確認
throw *pError;
:
}
catch(DBSQLCA e)
{
}
try
{
:
pDriver = DriverManager.Driver(StrDBMSName);
// 使用するDBMSの定義
:
}
catch(DBSQLCA e)
{
if(e.RetCode==DB_ERROR_NOT_ENOUGH_MEMORY)
//エラーコードを判定に使う
:
}