表示される長さを返す

# pg_field_prtlen

(PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8)

pg_field_prtlen — 表示される長さを返す

### 説明

function pg_field_prtlen(PgSql\Result `$result`, string|false|null `$row`, mixed `$field_name_or_number`): int
function pg_field_prtlen(PgSql\Result `$result`, mixed `$field_name_or_number`): int

pg_field_prtlen() は、 `result` で指定した値に関して、実際に 表示した場合の長さ(文字の数)を返します。行番号(row_number)は 0 から始まります。この関数は、エラーの場合に `false` を返します。

`field_name_or_number` は、int または string のどちらかで渡すことが可能です。 int で渡された場合、PHP はそれをフィールド番号と判断 します。それ以外の場合はフィールド名と判断します。

pg_field_name() ページの例を参照ください。

> 注意:

> この関数は、以前は pg_fieldprtlen() と呼ばれていました。

### パラメータ

`result`
  pg_query()、pg_query_params() や (様々な関数がありますが、特に) pg_execute() が返した PgSql\Result クラスのインスタンス。
`row`

  結果の行番号。行番号は 0 から始まります。指定しなかった場合は カレントの行を取得します。

### 戻り値

フィールドの表示される長さを返します。

### 変更履歴

バージョン | 説明
--- | ---
8.3.0 | `row` は、nullable になりました。
8.1.0 | `result` は、PgSql\Result クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、resource を期待していました。

### 例

例1 フィールドの情報を取得する

    <?php
      $dbconn = pg_connect("dbname=publisher") or die("Could not connect");

      $res = pg_query($dbconn, "select * from authors where author = 'Orwell'");
      $i = pg_num_fields($res);
      for ($j = 0; $j < $i; $j++) {
          echo "column $j\n";
          $fieldname = pg_field_name($res, $j);
          echo "fieldname: $fieldname\n";
          echo "printed length: " . pg_field_prtlen($res, $fieldname) . " characters\n";
          echo "storage length: " . pg_field_size($res, $j) . " bytes\n";
          echo "field type: " . pg_field_type($res, $j) . " \n\n";
      }
    ?>

上の例の出力は以下となります。

    column 0
    fieldname: author
    printed length: 6 characters
    storage length: -1 bytes
    field type: varchar

    column 1
    fieldname: year
    printed length: 4 characters
    storage length: 2 bytes
    field type: int2

    column 2
    fieldname: title
    printed length: 24 characters
    storage length: -1 bytes
    field type: varchar

### 参考

- pg_field_size() - 指定したフィールドの内部記憶領域におけるサイズを返す

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