PHP mysqli_field_seek() Function

Definition and Usage

A PHP result object (of the class mysqli_result) represents the MySQL result, returned by the SELECT or, DESCRIBE or, EXPLAIN queries.

The mysqli_field_seek() function accepts a result object and an integer value representing a field number, as parameters, and moves the field seek of the given result object to the specified field.

Syntax

mysqli_field_seek($result, $field);

Parameters

Return Values

The PHP mysqli_field_seek() function returns a boolean value which is, TRUE incase of success and FALSE incase of failure.

PHP Version

This function was first introduced in PHP Version 5 and works works in all the later versions.

Example

Following example demonstrates the usage of the mysqli_field_seek() function (in procedural style) −

<?php
   $con = mysqli_connect("localhost", "root", "password", "mydb");

   mysqli_query($con, "CREATE TABLE myplayers(ID INT, First_Name VARCHAR(255), Last_Name VARCHAR(255), Place_Of_Birth VARCHAR(255), Country VARCHAR(255))");
   print("Table Created.....\n");
   mysqli_query($con, "INSERT INTO myplayers values(1, 'Sikhar', 'Dhawan', 'Delhi', 'India')");
   mysqli_query($con, "INSERT INTO myplayers values(2, 'Jonathan', 'Trott', 'CapeTown', 'SouthAfrica')");
   mysqli_query($con, "INSERT INTO myplayers values(3, 'Kumara', 'Sangakkara', 'Matale', 'Srilanka')");
   print("Record Inserted.....\n");

   //Retrieving the contents of the table
   $res = mysqli_query($con, "SELECT * FROM myplayers");

   //Moving the seek to 3rd field
   mysqli_field_seek($res, 2);

   //Fetching the fields
   $info = mysqli_fetch_field($res);
   //Current field
   $currentfield = mysqli_field_tell($res);
   print("Current Field: ".$currentfield."\n");
   print("Name: ".$info->name."\n");
   print("Table: ".$info->table."\n");
   print("Max Length: ".$info->max_length."\n");
   print("Flags: ".$info->flags."\n");
   print("Type: ".$info->type."\n");


   //Closing the statement
   mysqli_free_result($res);

   //Closing the connection
   mysqli_close($con);
?>

This will produce following result −

Table Created.....
Record Inserted.....
Current Field: 3
Name: Last_Name
Table: myplayers
Max Length: 10
Flags: 0
Type: 253

Example

In object oriented style the syntax of this function is $result->field_seek; Following is the example of this function in object oriented style $minus;

<?php
   //Creating a connection
   $con = new mysqli("localhost", "root", "password", "mydb");

   $con -> query("CREATE TABLE Test(Name VARCHAR(255), AGE INT)");
   $con -> query("insert into Test values('Raju', 25),('Rahman', 30),('Sarmista', 27)");
   print("Table Created.....\n");

   $stmt = $con -> prepare( "SELECT * FROM Test WHERE Name in(?, ?)");
   $stmt -> bind_param("ss", $name1, $name2);
   $name1 = 'Raju';
   $name2 = 'Rahman';

   //Executing the statement
   $stmt->execute();

   //Retrieving the result
   $result = $stmt->get_result();

   //Moving the seek to the 2nd field
   $result->field_seek(1);

   //Fetching the 2nd field Current Field
   $info = $result->fetch_field();

   $field = $result->current_field;
   print("Current Field: ".$field."\n");
   print("Field Name: ".$info->name."\n");
   print("Field Type: ".$info->type);


   //Closing the statement
   $stmt->close();
 
   //Closing the connection
   $con->close();
?>

This will produce following result −

Table Created.....
Current Field: 2
Field Name: AGE
Field Type: 3