カタログ関数の入力引数

入力引数は、カタログ関数が戻す情報量の確認または制約を行います。

すべてのカタログ関数は、入力引数の CatalogName および SchemaName (さらに、 それらに関連する長さ) を持っています。 また、カタログ関数には、入力引数 TableName、ProcedureName、 および ColumnName (さらに、それらに関連する長さ) も指定できます。 ただし、Db2® ODBC は、3 部構成の名前をサポートしていないため、CatalogName は、 必ず NULL ポインター (長さは 0 に設定) でなければなりません。

それぞれの入力引数は、パターン値引数または通常の引数として説明されています。引数の記述は、カタログ関数によって異なります。 例えば、SQLColumnPrivileges() は SchemaName および TableName を 通常引数として扱いますが、SQLTables() はこれらの引数をパターン値引数として 扱います。

通常引数とは、文字通りに扱われる入力です。これらの引数には、大/小文字の区別があります。 通常引数は、照会を修飾するのではなく、入力情報を明示的に識別します。 NULL ポインターをこのタイプの引数に渡すと、結果は予測不能になります。

パターン値引数は、基礎となる照会を WHERE 文節で修飾した場合のように、 結果セットのサイズに制約を加えます。 パターン値入力に NULL ポインターを渡した場合は、その引数は結果セットの制限には使用 されません (すなわち、照会を制約する WHERE 文節はありません)。 カタログ関数に複数のパターン値入力引数がある場合は、これらの引数は、 基礎となる照会の WHERE 文節が AND で結合された場合のように扱われます。 カタログ関数が指定したすべてのパターン値引数の条件に当てはまる行がある場合のみ、 結果セットに行が現れます。

それぞれのパターン値引数に、以下の文字を含めることができます。
  • 任意の単一文字を表す下線 (_) 文字。
  • ゼロまたは 1 つ以上の任意の一連の文字を表すパーセント (%) 文字。
  • それ自体を表す文字。 大/小文字の区別が有効です。

これらの引数値は、WHERE 文節内の概念 LIKE 述部で使用されます。 メタデータ文字 (「_」および「%」) を文字として扱うためには、「_」または「%」文字 の直前にエスケープ文字を入れる必要があります。 エスケープ文字そのものをパターン値引数のリテラル部分として使用する場合は、 エスケープ文字を 2 回続けて入れます。 SQL_SEARCH_PATTERN_ESCAPE を設定した引数 InfoType を指定して SQLGetInfo() を呼び 出すことによって、ODBC ドライバーが使用するエスケープ文字を判別することができます。

EBCDIC、ユニコード、および ASCII のコード化スキームを用いてカタログ関数を 使用することができます。 初期化ファイルの CURRENTAPPENSCH キーワードは、これらのコード化スキームのどれが 使用されているかを判別します。EBCDIC、ユニコード UTF-8、および ASCII 入力ストリングは 、汎用カタログ関数を使用します。UCS-2 入力ストリングの場合、接尾部が W のカタログ関数を使用します。それぞれの汎用カタログ関数ごとに、対応する接尾部が W の API が UCS-2 サポートを提供します。