fbsql_fetch_field

(PHP 4 >= 4.0.6, PHP 5, PHP 7)

fbsql_fetch_field — 結果からカラム情報を得て、オブジェクトとして返す

説明

fbsql_fetch_field ( resource $result [, int $field_offset ] ) : object

クエリ結果のフィールドについての情報を取得するために使用されます。

パラメータ

result

fbsql_query() あるいは fbsql_db_query() が返す結果 ID。

field_offset

フィールドの数値オフセット。フィールドのインデックスは 0 からはじまります。 省略した場合は、まだ fbsql_fetch_field() で取得されていない フィールドのうちで最小のものが取得されます。

返り値

フィールド情報を含むオブジェクト、あるいはエラー時に FALSE を返します。

オブジェクトのプロパティは以下のとおりです。

  • name - カラム名。
  • table - カラムが属するテーブルの名前。
  • max_length - カラムの最大長。
  • not_null - カラムが NULL にならない場合に 1。
  • type - カラムの型。

例

例1 fbsql_fetch_field() の例

<?php
fbsql_connect($host, $user, $password)
    or die("接続できません");
$result = fbsql_db_query("database", "select * from table")
    or die("クエリに失敗");
# get column metadata
$i = 0;
while ($i < fbsql_num_fields($result)) {
    echo "カラム $i の情報:<br />\n";
    $meta = fbsql_fetch_field($result);
    if (!$meta) {
        echo "使用可能な情報がありません<br />\n";
    }
    echo "<pre>
max_length:   $meta->max_length
name:         $meta->name
not_null:     $meta->not_null
table:        $meta->table
type:         $meta->type
</pre>";
    $i++;
}
fbsql_free_result($result);
?>

参考

  • fbsql_field_seek() - 指定したフィールドオフセットに結果ポインタを設定する