PEAR Manual
Prev |  | Next

# DB_result::fetchInto()

DB_result::fetchInto() -- Fetches a row of a result set into a variable

## Synopsis

``integer fetchInto` (array &$arr [, integer $fetchMode = `DB_FETCHMODE_DEFAULT` [, integer $rowNum = `NULL`]])`

## Description

Places a row of data from a result set into a variable you provide then moves the result pointer to the next row. The data can be formatted as an array or an object.

## Parameter

mixed `$arr`

  reference to a variable to contain the row

integer `$fetchMode`

  the fetch mode to use. The default is `DB_FETCHMODE_DEFAULT`, which tells this method to use DB's current fetch mode. DB's current default fetch mode can be changed using setFetchMode(). Potential values include:

  - `DB_FETCHMODE_ORDERED`

  - `DB_FETCHMODE_ASSOC`

  - `DB_FETCHMODE_OBJECT`

integer `$rowNum`

  the row number to fetch. Note that 0 returns the first row, 1 returns the second row, etc.

## Return value

integer - `DB_OK` if a row is processed, `NULL` when the end of the result set is reached or a DB_Error object on failure

## Note

This function can not be called statically.

## Example

Example 33-1. Using fetchInto()
    <?php
    // Once you have a valid DB object named $db...
    $res =& $db->query('SELECT * FROM mytable');
    while ($res->fetchInto($row)) {
        // Assuming DB's default fetchmode is
        // DB_FETCHMODE_ORDERED
        echo $row[0] . "\n";
    }
    ?>

## See

"Intro - Results", setFetchMode(), fetchRow()

Prev | Home | Next
DB_result | Up | DB_result::fetchRow()