特殊カラムを取得する

# odbc_specialcolumns

(PHP 4, PHP 5, PHP 7, PHP 8)

odbc_specialcolumns — 特殊カラムを取得する

### 説明

function odbc_specialcolumns(
Odbc\Connection `$odbc`,
int `$type`,
?string `$catalog`,
string `$schema`,
string `$table`,
int `$scope`,
int `$nullable`
): Odbc\Result|false

テーブルのレコードを特定する最適なカラムの組合せ、 またはレコードの値がトランザクションにより更新される際に自動的に更新されるカラムを取得します。

### パラメータ

`odbc`
  ODBC 接続オブジェクト。詳細は odbc_connect() を参照ください。
`type`
  引数 type が `SQL_BEST_ROWID` の場合、 odbc_specialcolumns() はテーブルの各レコードを特定するカラムを返します。 引数 type が `SQL_ROWVER` の場合、 odbc_specialcolumns() はカラムから値を取得する ことにより指定したテーブルでレコードを特定できる最適なカラムまたはカラムの組を返します。
`catalog`

  カタログ(ODBC 2 の用語では '修飾子')。

`schema`

  スキーマ (ODBC 2 の用語では '所有者')。

`table`

  テーブル。

`scope`

  スコープ。これは結果セットを並べかえる際に使用します。 `SQL_SCOPE_CURROW`, `SQL_SCOPE_TRANSACTION`, `SQL_SCOPE_SESSION` のいずれかを指定します。

`nullable`

  NULL を持つ特別なカラムを返却するかどうかを指定します。 `SQL_NO_NULLS`, `SQL_NULLABLE` のいずれかを指定します。

### 戻り値

ODBC 結果オブジェクトを返します。失敗した場合に `false` を返します。

結果セットのカラムは次のようになります。

- `SCOPE`
- `COLUMN_NAME`
- `DATA_TYPE`
- `TYPE_NAME`
- `COLUMN_SIZE`
- `BUFFER_LENGTH`
- `DECIMAL_DIGITS`
- `PSEUDO_COLUMN`

ドライバは追加のカラムを返すことが出来ます。

結果セットは `SCOPE` でソートされます。

### 変更履歴

バージョン | 説明
--- | ---
8.4.0 | 引数 `odbc` は、Odbc\Connection クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、resource を期待していました。
8.4.0 | この関数は Odbc\Result クラスのインスタンスを返すようになりました。 これより前のバージョンでは、resource を返していました。

### 参考

- odbc_tables() - 指定したデータソースに保存されたテーブルの名前のリストを取得する

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open