mysqli_result::field_seek

mysqli_field_seek

(PHP 5)

mysqli_field_seek — Set result pointer to a specified field offset

Description

Object oriented style (method):

bool mysqli_result::field_seek ( int $fieldnr )

Procedural style:

bool mysqli_field_seek ( mysqli_result $result , int $fieldnr )

Sets the field cursor to the given offset. The next call to mysqli_fetch_field() will retrieve the field definition of the column associated with that offset.

Note: To seek to the beginning of a row, pass an offset value of zero.

Parameters

result: Procedural style only: A result set identifier returned by mysqli_query(), mysqli_store_result() or mysqli_use_result().
fieldnr: The field number. This value must be in the range from 0 to number of fields - 1.

Return Values

Returns TRUE on success or FALSE on failure.

Examples

Example #1 Object oriented style


<?php

$mysqli = new mysqli("localhost", "my_user", "my_password", "world");



/* check connection */

if (mysqli_connect_errno()) {

    printf("Connect failed: %s\n", mysqli_connect_error());

    exit();

}



$query = "SELECT Name, SurfaceArea from Country ORDER BY Code LIMIT 5";



if ($result = $mysqli->query($query)) {



    /* Get field information for 2nd column */

    $result->field_seek(1);

    $finfo = $result->fetch_field();



    printf("Name:     %s\n", $finfo->name);

    printf("Table:    %s\n", $finfo->table);

    printf("max. Len: %d\n", $finfo->max_length);

    printf("Flags:    %d\n", $finfo->flags);

    printf("Type:     %d\n\n", $finfo->type);



    $result->close();

}



/* close connection */

$mysqli->close();

?>

Example #2 Procedural style


<?php

$link = mysqli_connect("localhost", "my_user", "my_password", "world");



/* check connection */

if (mysqli_connect_errno()) {

    printf("Connect failed: %s\n", mysqli_connect_error());

    exit();

}



$query = "SELECT Name, SurfaceArea from Country ORDER BY Code LIMIT 5";



if ($result = mysqli_query($link, $query)) {



    /* Get field information for 2nd column */

    mysqli_field_seek($result, 1);

    $finfo = mysqli_fetch_field($result);



    printf("Name:     %s\n", $finfo->name);

    printf("Table:    %s\n", $finfo->table);

    printf("max. Len: %d\n", $finfo->max_length);

    printf("Flags:    %d\n", $finfo->flags);

    printf("Type:     %d\n\n", $finfo->type);



    mysqli_free_result($result);

}



/* close connection */

mysqli_close($link);

?>

The above example will output:

Name:     SurfaceArea
Table:    Country
max. Len: 10
Flags:    32769
Type:     4