エラー
セッションが確立されていない (Scalable SQL または Btrieve データソー スへの接続が行われていない) 場合、SQLGetConnectOption はエラーを返 します。
付 録 Ａ 表 A-8 には、コールバック関数の設定と削除に使用するバッファの構造を 示します。
表 A-8
SQLSetConnectOption の Callback パラメータブロックの形式
サイズ データ型 説明
2 整数型 アクションナンバー: コールバック関数を登録す るには 0、コールバック関数を削除するには 1 を 設定します。
2 整数型 オプション: このパラメータには 0 を設定しま す。このパラメータは将来使用するために予約さ れています。
4 コールバック関数へ のポインタ
登録ま たは削 除する コール バック 関数の アド レ ス。
4 コールバック関数の ポインタバッファへ のポインタ (4 バイ トのサイズでなけれ ばなりません)
前に呼出したコールバック関数を格納していたバ ッファのアドレス。オプション 0 の場合、コール バック関数の格納バッファをゼロに初期化し、そ のアドレスを渡します。戻り値には、前に呼出し たコールバック関数のアドレスが含まれます (登 録されたものがある場合)。オプション 1 の場合 は、オプション 0 を使った呼出しの戻り値を含む バッファのアドレスを渡します。
4 文字バッファへのポ インタ
アプリケーション定義の構造体のアドレス。これ は、コールバックを行うときタスクが必要としま す。
4 文字バッファへのポ インタ (4 バイトの サイズでなければな りません)
前に呼出したコールバック関数の、アプリケーシ ョン定 義のバ ッファ に対す るポイ ンタの アド レ ス。オプション 0 の場合、このポインタをゼロに 初期化 し、そ のアド レスを 渡しま す。戻 り値 に は、前に呼出したコールバック関数の、アプリケ ーショ ン定義 の構造 体のア ドレス が含ま れま す (登録されたものがある場合)。オプション 1 の場 合は、オプション 0 を使った呼出しの戻り値を含 むバッファのアドレスを渡します。
コールバック関数のインストールまたは削除
コー ルバ ック 関 数の 形式 と その 使い 方 は、 『Scalable SQL Programmer's Manual』の XQLCallback の項と『Btrieve Programmer's Manual』で説明され ています。詳細については、これらのマニュアルを参照してください。
エラー
内部呼出しに失敗すると、SQLSetConnectOption はエラーを返します。
SQLSetConnectOption の呼出し
SQLSetConnectOption を呼出すには、次の操作を行います。
1. 実行するオプションに必要な形式に従って、入力バッファを設定します。
2. 接続を割り当てたときに ODBC から取得した接続ハンドル、オプショ ン番号、および入力バッファのアドレス (コンパイラから警告が出され るのを避けるため、必ず UDWORD 型にキャストする必要があります) を渡して、関数を呼出します。
パラメータの概要
SQLSetConnectOption 関数のパラメータは、それぞれのオプションごとに
個別に説明します。これは、オプションによってパラメータの解釈が異な るためです。
エラー
下層の SQL API 関数がエラーを返すと、 SQLSetConnectOption もエラー を返します。ODBC 関数の SQLError を使用すると、ネイティブエラーコ ードパラメータに返されたステータスコードなどのエラー情報を取得する ことができます。
接続がアクティブでない場合にも (オペレーションを完了するため、カー ソ ル ID が 内 部 的 に 割 り 当 て ら れ て い る 必 要 が あ る た め)、 SQLSetConnectOption はエラーステータスを返すことがあります。
オーナネームのリストを渡すとき、ネームリストが適切な形式になってい ないと、エラーが発生します。
Option 1004: データを変換する
このオプションを使用すると、データの内部形式と ASCII 表示形式を相互 に変換することができます。
付 録 Ａ パラメータの概要
表 A-9 には、データを変換するときの SQLGetConnectOption 関数のパラ メータをまとめてあります。
表 A-9
Option 1004 に対する SQLGetConnectOption のパラメータ
パラメータ 説明 値渡し 参照渡し
hdbc SQLAllocConnect の戻り値 ◆
fOption 定数値 (1004) ◆
vParam バッファのアドレス。呼出し時にコンパイ
ラから警告が出されるのを避けるため、こ のアドレスは UDWORD 型にキャストしま す。
◆
表 A-10 には、データを変換するために使用するバッファの構造を示しま す。
表 A-10
SQLGetConnectOption の Convert パラメータブロックの形式
サイズ データ型 説明
2 整数型 オプションナンバー: 内部形式を ASCII 表示形式に 変換するには 0、ASCII 表示形式を内部形式に変換 するには 1 を設定します。
2 整数型 変換する値の内部データ型。
2 整数型 変換する値の内部サイズ。
2 整数型 DECIMAL、MONEY、NUMERIC、NUMERICSA、お
よび NUMERICSTS 型に対する小数点以下の桁数。
その他のデータ型では 0 に初期化します。
2 整数型 次のデータ要素によってポイントされるバッファの サイズ (オプションに 0 が設定されている場合)、
または次のデータ要素によってポイントされるバッ ファ内のデータのサイズ (オプションに 1 が設定さ れている場合)。
4 文字バッファへ のポインタ
内部形式の値 (オプションに 0 が設定されている場 合)、または ASCII 表示形式の値 (オプションに 1 が設 定 さ れ てい る 場 合) を 含 む バ ッフ ァ の ア ド レ ス。
サイズ データ型 説明 4 文字バッファへ
のポインタ
出力バッファのアドレス。オプションに 0 が設定さ れている場合は ASCII 表示形式の値が含まれ、オプ ションに 1 が設定されている場合は内部形式の値が 含まれます。
4 文字バッファへ のポインタ
変換に使用するマスクを指定します。最大で半角 30 文字までのマスクを指定できます。29 文字以下の場 合は、マス クの末尾 をバイナ リゼロで 終了させ ま す。デフォルトマスクを使用するには、先頭のバイ トにバイナリゼロを格納します。
2 整数型 オプション 0:
左揃えの場合は 0、中央揃えの場合は 1、右揃えの 場合は 2 を指定します。
オプション 1:
文字列型データの先頭のブランクを削除するには 2 を指定します。このデータは右揃えとして扱われま す。文字列型データの先頭のブランクを削除しない 場合は、-1 を指定します。文字列型以外のデータ型 の場合、この値は無視されます。
データの変換
表 A-10 で 説 明 し た 入 力 の た め の バ ッ フ ァ を 設 定 し た 後 、
SQLGetConnectOption を呼出します。データが指定した形式に変換されま
す。
エラー
内部呼出しに失敗すると、SQLGetConnectOption はエラーを返します。
Option 1005: マスクを検証する
このオプションを使用すると、フィールドにデータを入力するときに使用 するマスクを検証することができます。
パラメータの概要
表 A-11 には、マスクを検証するときの SQLGetConnectOption 関数のパラ メータをまとめてあります。
付 録 Ａ 表 A-11
Option 1005 に対する SQLGetConnectOption のパラメータ
パラメータ 説明 値渡し 参照渡し
hdbc SQLAllocConnect の戻り値 ◆
fOption 定数値 (1005) ◆
vParam バッファのアドレス。呼出し時にコンパ
イ ラ か ら 警 告 が 出 さ れ る の を 避 け る た め、このアドレスは UDWORD 型にキャ ストします。
◆
表 A-12 には、マスクを検証するために使用するバッファの構造を示しま す。
表 A-12
SQLGetConnectOption の Mask Validation パラメータブロックの形式
サイズ データ型 説明
2 整数型 内部データ型のコードを指定します。
2 整数型 データ型の内部サイズをバイト単位で指定します。
2 整数型 指定したデータ型で使用する小数点以下の桁数を指定し ます。
2 整数型 検証するマスクのバイト単位の長さを初期化します。
4 文字バッファ へのポインタ
検証するマスクを含む文字列のアドレスを指定します。
マスクの検証
入力のためのバッファを設定した後、SQLGetConnectOption を呼出します。
マスクが検証されます。戻り値の SQL_SUCCESS はマスクが有効である ことを表します。
エラー
マスクが有効でない場合、SQLGetConnectOption はエラーを返します。
Option 1006: デフォルトマスクを取得する
このオプションを使用すると、フィールドにデータを入力するときに使用 するデフォルトマスクを取得できます。
パラメータの概要
表 A-13 には、デフォルトマスクを取得するときの SQLGetConnectOption 関数のパラメータをまとめてあります。
表 A-13
Option 1006 に対する SQLGetConnectOption のパラメータ
パラメータ 説明 値渡し 参照渡し
hdbc SQLAllocConnect の戻り値 ◆
fOption 定数値 (1006) ◆
vParam バッファのアドレス。呼出し時にコンパイ
ラから警告が出されるのを避けるため、こ のアドレスは UDWORD 型にキャストし ます。
◆
表 A-14 には、デフォルトマスクを取得するために使用するバッファの構 造を示します。
表 A-14
SQLGetConnectOption の Default Mask Retrieval パラメータブロックの形式
サイズ データ型 説明
2 整数型 内部データ型のコードを指定します。
2 整数型 データ型の内部サイズをバイト単位で指定します。
2 整数型 指定したデータ型で使用する小数点以下の桁数を指定しま す。
2 整数型 デフォルトマスクを格納するバッファで使用可能なバイト 数を初期化します。戻り値として、返されたデフォルトマ スクの長さがバイト単位で格納されます。
4 文字バッフ ァへのポイ ンタ
デフォルトマスクを含む文字列が格納されるバッファのア ドレスを指定します。
付 録 Ａ デフォルトマスクの取得
表 A-14 で説明した入力のためのバッファを設定した後、 SQLGetConnect Option を呼出します。返されるマスクは、指定したデータ型に対応するデ フォルトマスクです。
エラー
入力パラメータが有効でない場合、SQLGetConnectOption はエラーを返し ます。
Option 1007: 値を検証する
このオプションを使用すると、指定したフィールドまたはフィールドのグ ループを対象にその値を検証できます。
パラメータの概要
表 A-15 には、値を検証するときの SQLGetConnectOption 関数のパラメー タをまとめてあります。
表 A-15
Option 1007 に対する SQLGetConnectOption のパラメータ
パラメータ 説明 値渡し 参照渡し
hdbc SQLAllocConnect の戻り値 ◆
fOption 定数値 (1007) ◆
vParam バッファのアドレス。呼出し時にコンパ
イ ラ か ら 警 告 が 出 さ れ る の を 避 け る た め、このアドレスは UDWORD 型にキャ ストします。
◆